Repository navigation
Documentation bodies focus on their subject - #293
Merged
Marius Storhaug (MariusStorhaug) merged 2 commits intoNov 12, 2026
Merged
Conversation
There was a problem hiding this comment.
🟢 Approved
No active review issues are reported for the documentation changes clarifying reusable-instruction maintenance.
No open issues 🎉
What changed in this PR
This PR clarifies how reusable instructions are maintained within the existing contribution workflow, without adding automated enforcement or changing product behavior.
Changes:
- Applies code engineering practices to durable instructions while exempting one-off chat requests from source-control and pull-request requirements.
- Clarifies that immediate self-improvement starts a proposal; guidance becomes accepted only after review, approval, and merge.
- Requires corrections at the canonical source, with dependent instructions linking rather than copying rules.
| File | Description |
|---|---|
src/docs/Ways-of-Working/Evolutionary-Development.md |
Clarifies instruction maintenance, acceptance requirements, and canonical-source reuse while preserving the existing section anchor. |
Review effort: Balanced
9 tasks done
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 12, 2026 14:11
Marius Storhaug (MariusStorhaug)
deleted the
canonical-guidance-ownership
branch
November 12, 2026 15:18
This was referenced Nov 12, 2026
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
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.
Documentation authors keep document bodies focused on the subject and leave document-maintenance records in source control and reviews. Required navigation fields stay, as do the rationale, mechanisms, contract links, and evidence that explain the subject.
Reusable instructions also follow code engineering practices. Contributors correct missing or incorrect rules in their canonical documents before updating dependent instructions, and reviewed PR merge determines when a correction becomes accepted guidance.
Changed: Documentation bodies focus on the subject, not the document
Remove self-descriptive introductions, bylines, document-owner fields, approval status, review dates, document versions, revision history, and authoring notes from document bodies. Keep the required navigation front matter, including
titleanddescription.Keep the subject's scope, requirements, source links, design rationale, mechanisms, alternatives, and evidence. Operational ownership, product versions, observation dates, and decision status remain when readers need those facts to understand or use the subject. This is not a request to remove useful design explanations or subject data.
The general rule has one home in Documentation Model: Subject-focused content. Authoring conventions and templates reference it. Design, implementation, reference, playbook, and decisions-register placeholders now request subject content instead of page self-description. The edited standards also remove self-introductory wording.
This changes authoring guidance and the reusable templates, not product interfaces or automated enforcement. No product upgrade or migration is required. Existing documentation outside the four edited pages is not rewritten in this PR.
Technical details
The scoped PR comparison is
f9b335d0b78a3eead0b7efa573936e86cb1e7265toff73af361768c744351d0c5353a4b79fd267ac83. The subject-focused follow-on is isolated in commitff73af361768c744351d0c5353a4b79fd267ac83after the original lifecycle commit.The delivery issue records the direct follow-on scope, the confirmed navigation-field exception, and verification of ordinary instructions, design rationale, ownership, versions, observation dates, and decision records. Actual page navigation front matter and existing headings remain unchanged.
Fresh local validation passed: shared Markdown lint is clean for all four changed pages; local links resolve across 130 documentation files; all 8 cross-repository links resolve; all 66 Pester tests pass across 6 suites. The fresh automated review approved this candidate with no new inline comments.
Every current validation check reports completion and success. Publish is intentionally skipped for pull requests. A native retry resolved the earlier inconsistent Links completion state; the current Links check
131200062620explicitly reportscompletedandsuccess. No readiness gate was waived. The Docs workflow and cross-repository workflow completed successfully.Documentation-Model.md,Spec-Driven-Development.md,Spec-Driven-Development-Templates.mdundersrc/docs/Ways-of-Working/The scoped issue sweep covered metadata and self-description terms. No additional issue is fully satisfied. Navigation-generation and tooling-output metadata work remain separate.
The publication route in
.github/workflows/Docs.ymlbuilds and publishes the documentation site without invoking Release Management. Release metadata and labels are omitted. No integration-template change applies.Changed: Reusable instruction changes use the code delivery process
Standards, guides, stored prompts, skills, and agent files follow the existing contribution workflow, including source control, testing and verification, pull requests, review, and acceptance. A correction becomes accepted guidance only after its pull request is reviewed, approved, and merged. One-off chat requests do not require a versioned artifact or pull request merely to receive or act on the request.
Maintainers correct a missing or incorrect rule in its owning canonical document before updating dependent instructions. Dependent entry points reference that document rather than copy its rules. This applies to every canonical document, not only PR Format. Immediate self-improvement starts a proposal; it does not bypass verification or make an unreviewed correction accepted guidance.
Technical details
src/docs/Ways-of-Working/Evolutionary-Development.mdretains the instruction-maintenance section and its anchor. Its opening now describes the feedback cycle instead of the standard itself. The lifecycle and source-first changes remain isolated in the original commita16564842877015f06d6f86b814f42d34c106a26.The original five examples cover missing PR rules, missing rules in other canonical documents, incorrect instructions, reusable instruction changes, and one-off chat requests. The expanded candidate has its own fresh approved automated review; the earlier approval is not used to validate the new diff.
src/docs/Ways-of-Working/Evolutionary-Development.mdThe instruction-convergence sweep covered instruction/canonical title terms, instruction-and-code body terms, and the owning document name. No additional issue is fully satisfied. Instruction trust-boundary and diagnosis work remain separate.
This PR remains a draft, with merge and auto-merge disabled.
Related references