Repository navigation
Repository governance contracts use direct English - #259
Open
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Conversation
8 tasks done
There was a problem hiding this comment.
🟢 Approved
No active review issues block the documentation changes clarifying repository-governance guidance.
No open issues 🎉
What changed in this PR
This documentation-only PR rewrites repository-governance guidance in direct English, clarifying existing contracts without changing live enforcement.
Changes:
- Clarifies the README’s role as a short introduction that links to detailed product documentation.
- Simplifies guidance on repository boundaries, classification, ownership, and automation labels.
- Clarifies shared controls and reconciliation requirements, distinguishing design contracts from implementation evidence.
| File | Description |
|---|---|
src/docs/Ways-of-Working/Repository-Type-Property.md |
Simplifies classification, migration, and ruleset coverage guidance. |
src/docs/Ways-of-Working/Repository-Standard.md |
Clarifies README scope and documentation layout. |
src/docs/Ways-of-Working/Repository-Segmentation.md |
States repository boundary and lifecycle criteria directly. |
src/docs/Ways-of-Working/Readme-Driven-Context.md |
Clarifies README context, maintenance, and audience guidance. |
src/docs/Ways-of-Working/Organization-Standard.md |
Simplifies shared governance guidance and links the Distributor example. |
src/docs/Ways-of-Working/Code-Ownership.md |
Clarifies permissions, review assignment, and merge enforcement. |
src/docs/Ways-of-Working/Automation-Labels.md |
Simplifies label ownership and namespace rules. |
src/docs/Capabilities/repository-governance/spec.md |
Restates classification requirements and success criteria directly. |
src/docs/Capabilities/repository-governance/index.md |
Summarizes classification, shared controls, and reconciliation. |
src/docs/Capabilities/repository-governance/design.md |
Clarifies control design and the reconciliation contract. |
src/docs/Capabilities/repository-governance/design-types.md |
Simplifies type definitions, composition, and validation guidance. |
Review effort: Balanced
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
This was referenced Nov 4, 2026
[documentation-writing-alignment] Define one discoverability minimum for Unmanaged repositories
#277
Open
This branch has not been deployed
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.
Repository governance guidance uses clear en-US and present-tense statements across seven policy pages and four capability pages. It explains repository context, label ownership, code-owner review, type selection, and reconciliation without idioms.
Requirements and interfaces keep their meaning. The guidance distinguishes the governance contract from evidence of deployed enforcement. No adoption action is required.
Changed: Governance guidance states its contract directly
Contributors, maintainers, and agents can read the repository rules without interpreting navigation metaphors or delivery-status language. README guidance names the repository's capabilities and links to details. Repository boundaries follow ownership, lifecycle, and branch strategy. Code-owner guidance separates permission, review assignment, and required approval.
The distribution example states only what its source documentation describes. The defaults-repository table defines the required contract, not verified deployment. The Artifact rationale explains the chosen one-commit-per-change policy without claiming that Git cannot inspect merge history. Type values, required files, inheritance rules, local-guide conditions, API methods, commands, migration safeguards, and normative requirements do not change.
Technical details
Source and scope. The fixed expectations and scoped PR base are
MSXOrg/docs@1b0d4893c8fefabe604d04393068a8ff6f848082. The final candidate isMSXOrg/docs@e978a6c10675a175d640e663f5e91bdcbb7be219, read back from local HEAD, the remote branch, and this PR. Seven small commits are pushed. The worktree is clean. The PR remains draft, unmerged, and without auto-merge. No readiness, merge, or Agent merge action is performed.The actual
Docs.ymlroute builds and deploys a documentation site and does not invoke Release Management. This is a scoped documentation comparison, not a release-bound artifact comparison. No release-decision block orrelease:*label applies.Pinned expectations. The review uses Documentation Model, Natural Language, Writing Guide, Markdown, Documentation, and applicable specification, design, and standard templates. The STEMG overview, FAQ, and relevant Issue 9 rules/dictionary inform the manual review. The verified PDF and extract remain local. Mechanical checks do not establish full STE conformance.
Full read and before/after evidence
All 11 owned pages were read in full before edits and are changed. There is no owned no-change path. Each target is absent in the baseline and present in the final source and rendered page article.
src/docs/Ways-of-Working/Automation-Labels.mdsrc/docs/Ways-of-Working/Code-Ownership.mdCODEOWNERSassigns reviewers to repository paths. It does not grant access or require approval before merge."src/docs/Ways-of-Working/Organization-Standard.mdsrc/docs/Ways-of-Working/Repository-Segmentation.mdsrc/docs/Ways-of-Working/Repository-Standard.mdsrc/docs/Ways-of-Working/Repository-Type-Property.mdsrc/docs/Ways-of-Working/Readme-Driven-Context.mdsrc/docs/Capabilities/repository-governance/index.mdsrc/docs/Capabilities/repository-governance/spec.mdsrc/docs/Capabilities/repository-governance/design.mdsrc/docs/Capabilities/repository-governance/design-types.mdTechnical preservation and source-qualified corrections
Manual comparison preserves ownership/permission/enforcement distinctions, all Type and legacy inventory values, release-label meanings and route scope, migration ordering and verification gates, API methods/routes, commands, inherited defaults, conditional local guides, exceptions, and direct instructions.
Mechanical comparison confirms unchanged page titles, headings/anchors, fenced examples, uppercase normative-term sequence, existing inline-identifier set, existing link destinations, generated index blocks, the complete spec FR/NFR block, complete Type tables, the community-default section, and the local contribution rule. The sole added destination is the verified canonical Distributor repository. Historical inventories and safe migration procedures retain their roles. The content-location paragraph becomes five- and two-sentence paragraphs.
The
PSModule/Distributorreference resolves to MSXOrg/Distributor. Its README at3beed03f64eeafdad1c5986a14845a2b7811f929describes managed-file distribution for PSModule. That evidence supports a documentation example, not deployed-service or conformance claims.The defaults source trees are pinned at MSXOrg/.github@0c67251812ea306543f3a14ab473ae357cfb76ac and PSModule/.github@4e0092de8f208b11e0d4607ced93471607aa748e. The first contains a PR-template file despite the target policy. The design therefore states the contract rather than claiming that linked repositories prove compliance. External template cleanup is excluded.
An anonymous Git-object experiment joins five feature commits and an independent main-branch change.
git bisect runfinds feature 3 as the first bad commit;git log v0..v1includes all five feature changes. Verified LF fixtures and a predicate that aborts on invalid input make the result reproducible. This disproves the absolute failure explanation, not the chosen Artifact history policy. The Git bisect manual supplies command semantics. No project code or credentials are used; the temporary experiment is removed.Validation
markdownlint-cli20.24.0, shared configuration, all 11 explicit paths, zero issues.zensical==0.0.59; final-source archive; CI index generation in an isolated copy; no build issues; 131 HTML pages. All 11 owned pages, H1s, target text, generated descriptions, and Distributor link are verified.The shared installed Zensical
0.0.50is not used as a substitute. The exact existing requirement is restored in isolated session storage without changing the manifest or shared environment. Source index tables are not regenerated or committed; only the build copy receives generated tables.Standards and framework alignment
Unresolved policy choices and exclusions
These choices remain explicit and unchanged. They need a separate policy PR, not an inferred writing decision.
The closing Task's prose, preservation, validation, and durable-evidence steps are complete. All shared indexes, other documentation parts, functional scripts/configuration/tests, dependencies, and paths reserved by #240 remain unchanged. No repository audit/planning files, new tooling, restructuring, or external enforcement cleanup is added. No complete STE certification or deployed-reconciliation claim is made.
The scoped convergence query
repo:MSXOrg/docs is:issue is:open "repository governance" in:title,bodyreturns only the closing Task. No additional issue receives a closing link. There is no remaining blocker for this writing deliverable; this PR stays draft by request.Related references