Skip to content

docs: openspec specs + feature reference pages for the recent feature trio#136

Merged
rubenvdlinde merged 1 commit intodevelopmentfrom
feature/openspec-recent-features
May 7, 2026
Merged

docs: openspec specs + feature reference pages for the recent feature trio#136
rubenvdlinde merged 1 commit intodevelopmentfrom
feature/openspec-recent-features

Conversation

@rubenvdlinde
Copy link
Copy Markdown
Contributor

Summary

Closes the documentation debt from PRs #129, #130, #131. Those shipped code without companion OpenSpec specs or docs/features/*.md reference pages.

What landed

Three OpenSpec specs

Spec REQ-* Covers
openspec/specs/default-widget-bundle/spec.md REQ-DWB-001..006 Four-widget seed bundle, tileType='preset' serialization gate, bootstrap-path bypass, create-response envelope with placements, Views.vue loading shim
openspec/specs/effective-default-marker/spec.md REQ-EDM-001..005 ★ icon, effective-default chain (pin → group default → fallback), intentional exclusion of step 6, tooltip + aria-label, theme color via --color-warning
openspec/specs/dashboard-deeplinking/spec.md REQ-DDL-001..007 Catch-all page#deepLink route with negative-lookahead, server-side resolution + silent fallback, canonical-path round-trip via replaceState, GET /api/dashboards/{uuid}/path endpoint, frontend pushState + popstate, /api/health regression check

Three feature reference pages

  • docs/features/default-widget-bundle.md
  • docs/features/effective-default-marker.md
  • docs/features/dashboard-deeplinking.md

Each documents what the capability does at the user / API level, when it fires, where the code lives, and links to the relevant tutorials and the spec source.

README.md

  • Documentation badge moved from mydash.app to mydash.conduction.nl
  • Front-matter gains a journeydoc link so contributors know the tutorial pattern

Test plan

  • All three specs follow the existing openspec/specs/*/spec.md shape (frontmatter + Purpose + Context + Requirements with REQ-* tags)
  • All three feature pages cross-link to their spec + the relevant tutorials
  • CI runs docusaurus build — verify clean (the local worktree hits an intermittent SSG render issue that the production deploy doesn't reproduce; trusting CI as ground truth)
  • Manual review of the rendered pages once deployed

Notes

  • Specs are status: implemented since the code already shipped. Future drift between code and spec is now visible.
  • The feature pages reference /screenshots/... paths that the journeydoc capture spec populates; missing screenshots warn but don't fail the build (per the journeydoc convention).

… trio

Three features shipped as code in PRs #129/#130/#131 without their
companion OpenSpec specs and without `docs/features/*.md` reference
pages. Closing the documentation debt:

OpenSpec specs (`openspec/specs/<capability>/spec.md`):

- `default-widget-bundle` — REQ-DWB-001..006: the four-widget seed
  bundle on user-initiated dashboard creation, the `tileType='preset'`
  serialization gate, the bootstrap-path bypass, the create-response
  envelope shape with placements, and the `Views.vue` loading shim.
- `effective-default-marker` — REQ-EDM-001..005: the ★ icon, the
  effective-default chain (pin → group default → fallback), the
  intentional exclusion of step 6 (personal dashboards), tooltip +
  aria-label, theme color via `--color-warning`.
- `dashboard-deeplinking` — REQ-DDL-001..007: the catch-all
  `page#deepLink` route with negative-lookahead to exclude `/api/...`,
  server-side resolution + silent fallback (never 404), canonical
  path round-trip via `replaceState`, the new
  `GET /api/dashboards/{uuid}/path` endpoint, frontend `pushState` on
  switch + `popstate` listener, the `/api/health` regression check.

Feature reference pages (`docs/features/*.md`) — what each capability
does at the user / API level, when it fires, where the code lives,
links into the relevant tutorials and the spec source.

`README.md` — tutorial site moved from `mydash.app` to
`mydash.conduction.nl`, and the front-matter blurb gains a
[journeydoc](https://github.com/ConductionNL/hydra/blob/development/openspec/architecture/adr-030-journeydoc-pattern.md)
link so contributors know the tutorial pattern that produced the docs.
@rubenvdlinde rubenvdlinde requested a review from Rem-Dam as a code owner May 7, 2026 05:00
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Quality Report — ConductionNL/mydash @ 16396d5

Check PHP Vue Security License Tests
lint
phpcs
phpmd
psalm
phpstan
phpmetrics
eslint
stylelint
composer ✅ 100/100
npm ✅ 501/501
PHPUnit
Newman
Playwright ⏭️

Coverage: 90.7% (127/140 statements)


Quality workflow — 2026-05-07 05:03 UTC

Download the full PDF report from the workflow artifacts.

@rubenvdlinde rubenvdlinde merged commit c9e7ef0 into development May 7, 2026
46 checks passed
@rubenvdlinde rubenvdlinde deleted the feature/openspec-recent-features branch May 7, 2026 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant