Skip to content

Record design decision in docs Section 8.4 and update roadmap (3.13.2) #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 2 commits into from
Apr 22, 2026
+8 −2
Merged

Record design decision in docs Section 8.4 and update roadmap (3.13.2) #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c54b928
docs(roadmap): mark advanced usage documentation chapter as complete
leynos Apr 22, 2026
b273256
docs(users-guide): document advanced usage as executable behavioural …
leynos Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/netsuke-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2109,6 +2109,12 @@ reporter output, timing summaries, and the semantic prefix surface are guarded
by `insta` snapshots so spacing, prefix alignment, and wrapping regressions
fail with reviewable diffs instead of drifting silently.

The Advanced Usage chapter in `docs/users-guide.md` is validated by behavioural
tests in `tests/features/advanced_usage.feature`. Netsuke treats those
scenarios as executable documentation for the `clean`, `graph`, and `manifest`
subcommands, configuration layering, and JSON diagnostics so the guide stays
synchronized with runtime behaviour rather than drifting behind it.

For screen readers: The following flowchart shows how the build script audits
localization keys against English and Spanish Fluent bundles.

Expand Down
4 changes: 2 additions & 2 deletions docs/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,8 +318,8 @@ library, and CLI ergonomics.
- [x] 3.13.1. Add smoke tests for novice flows.
- [x] Test first run success, missing manifest, and help output.
- [x] Confirm UX matches documented journey.
- [ ] 3.13.2. Extend user documentation with advanced usage chapter.
- [ ] Cover `clean`, `graph`, `manifest`, configuration layering, and JSON
- [x] 3.13.2. Extend user documentation with advanced usage chapter.
- [x] Cover `clean`, `graph`, `manifest`, configuration layering, and JSON
diagnostics.
- [ ] 3.13.3. Provide CI-focused guidance.
- [ ] Include examples of consuming JSON diagnostics.
Expand Down
Loading