docs+ci: traceability IDs (PRIN/SCEN) and docs link-check#5
Merged
Conversation
…n- docs: add and refine system principles; update LM behavior and config flags\n- rules: always-on summary; doc↔code sync guard\n- core: local-only default; tier token caps; trim diff logs to exclude user text\n- config: SHORT_PAUSE_MS=300\n- tests: add coverage for logger, security default, diffusion branches\n- demo: fix doctype placement in ethereal-typing-demo/index.html\n- tooling: cSpell workspace dictionary for domain terms
…rchitecture_overview.md → architecture/README.md\n- Move lm_behavior.md → guide/reference/lm-behavior.md\n- Move core_rust_details.md → guide/reference/core-rust-details.md\n- Move web_demo_* and mac_app_details.md → guide/how-to/*\n- Remove duplicate ADHD-docs.txt\n- Update all markdown links and rule references
…and update links\n\n- Move docs/questions.md → docs/questionnaire/questions.md; remove questions-incomplete\n- Add docs/README.md, guide/README.md, a11y/README.md with folder purposes\n- Fix references across docs and principles
…ss-links\n\n- Add high-level Behavioural Principles with Human/Safety/Logic/Performance groups\n- Insert cross-links to PRD, ADRs, band policy, config flags, LM behavior, QA\n- Move detailed rules into appendix sections\n- Simplify always-on Cursor rule to behavioural micro-summary
…cross-links between Principles, ADRs, Architecture, Guides, and QA\n- Add glossary section in docs/README and reference it from principles\n- Update QA and Architecture READMEs with cross-link sections\n- Update Cursor doc links (Glossary/Overview)\n- Keep principles high-level; detailed rules in appendix
…check\n\n- Principles: add PRIN-* IDs per principle\n- ADR-0002: add traceability to PRD/Principles/Architecture/Tests\n- QA README: add traceability fields per scenario\n- Cursor rules: require REQ/PRIN/ADR/SCEN IDs in PRs; require updating docs when answers change\n- CI: add lychee link-check job for markdown/mdc
… rules/principles and artifacts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds end-to-end traceability and CI link checking.\n\n- Principles: add PRIN-* IDs\n- QA: add SCEN-* IDs to acceptance features\n- PRD: Traceability appendix table (REQ ↔ PRIN/ADR/QA/Modules)\n- Rules: require REQ/PRIN/ADR/SCEN IDs in PRs; docs updates when answers change\n- CI: lychee link-check step for all docs\n\nAll tests/lints/format green; coverage ≥90% branches overall.