Repository navigation
MSX entry points provide factual context - #20
Conversation
There was a problem hiding this comment.
🟢 Approved
There are no active review issues for these documentation and agent-guidance updates.
No open issues 🎉
What changed in this PR
This prose-only PR gives readers factual context for MSX documentation and GitHub community defaults, and corrects the agent entry-point descriptions.
Changes:
- Adds public-profile orientation and links to MSX documentation and the community defaults repository.
- Updates agent read-order descriptions while preserving the README-then-CONTRIBUTING sequence and paths.
- Preserves the public profile’s brand heading.
| File | Description |
|---|---|
profile/README.md |
Adds guidance links and explains GitHub’s default-file fallback behavior. |
AGENTS.md |
Replaces overstated descriptions with accurate summaries of the linked documents. |
Review effort: Balanced
e90ab70
Fresh exact-head preparation - 2026-11-11Fresh commands, counts, provenance, and protection evidence cover unchanged head Fresh results: whitespace passes; 12/12 content/heading/read-order/wrapper assertions pass; both real canonical links return HTTP 200 with expected content; both exact-head files pass native GitHub Markdown interface checks. The cached Markdown linter returns results for 2 actual files, 0 violations using MSXOrg/docs The exact-head review is APPROVED; native review threads total 0. Hosted Markdown/link CI remains absent, not passed. The review execution succeeded but is not validation. Two queued app suites have no check runs. Classic protection returns 404, while inherited GitHub Flow rules require codeowner/last-push/thread-resolution controls and squash merge; no named required-status-check rule is present. No failing run is reported. Full API observations are in the linked evidence. No content decision remains. The PR stays open/non-draft, GitHub auto-merge is off, and Agent merge's merge action remains false. Merge stays on hold for the exclusive Process/root slot; this record is not merge authorization. |
The public MSX profile identifies the shared guidance and GitHub community-default context. The agent entry point describes its source documents without an enforcement claim.
Changed: Entry points describe their linked guidance
The profile links MSX documentation and the community-defaults repository. Agent instructions keep the README-then-CONTRIBUTING sequence and describe what those files contain. The brand heading and both wrapper routes remain unchanged. No reader or agent configuration change is required.
Technical details
Scope and persistent source
The comparison is
0c67251812ea306543f3a14ab473ae357cfb76ac...e90ab70966ccfa12f7c20a486fb40f5846062c9a. The PR contains onlyprofile/README.mdandAGENTS.md: nine added lines and two removed lines. The worktree is clean.Three small commits retain the implementation sequence:
ce0a2f3c7646fcbe4d06cb0fa5c857034ba164eb: add profile context and links; open this draft before the agent edit.5b6191d042d48503124cdfcad9a062182be546db: correct both agent read-order descriptions.e90ab70966ccfa12f7c20a486fb40f5846062c9a: usefile of that typefor the default-file explanation after the source-vocabulary review.The root README, contribution guide, PR template, forms, and SECURITY/SUPPORT policies are not changed. Root README audience clarification remains with its existing owner. No tooling, dependency, generated output, or documentation structure is added.
Source and factual review
The fixed authority is MSXOrg/docs commit
1b0d4893c8fefabe604d04393068a8ff6f848082, undersrc/docs/. The source review covers Documentation Model, Natural Language, Writing Guide, Markdown, Documentation, README-Driven Context, and the applicable workflow, contribution, PR, commit, branching, and completion guidance.The official STE description, FAQ, and Issue 9 DOI record are available. The local Issue 9 PDF has MD5
9c720341c350ed77943b2c73d01c716f, which matches the official record. The review uses the relevant verb, instruction, descriptive-writing, and dictionary guidance. The manual and extraction remain local.The added prose uses en-US, present tense, active voice, and short sentences. Its plain-text sentence lengths are 14, 8, and 15 words.
Read in this order:remains imperative.Ways of workingretains the source's technical term. The existing slogan is an accepted branding difference, not a claimed STE-compliant technical statement. Neither these checks nor a word count establish full STE conformance.All required pinned MSX and official STE sources are available. The custom instruction's literal parent
..\AGENTS.mdpath is absent. The repository rootAGENTS.mdis available, was read, and is the verified destination of both actual wrappers. No source or access blocker prevents this delivery.Before and after acceptance evidence
The pre-edit record retains the baseline failures. The same 12 acceptance checks return seven passes and five expected failures before editing, then 12 passes and no failures after editing. The final wording is included in the passing run.
https://msx.no/docs/is present and returns HTTP 200.The exact read order remains
README.md, then.github/CONTRIBUTING.md. Both target files exist. Both H1 texts are identical to the baseline, so their existing heading anchors remain stable. No heading or fragment is added..claude/CLAUDE.md@../AGENTS.mdAGENTS.md.github/copilot-instructions.mdFollow the instructions in [AGENTS.md](../AGENTS.md).AGENTS.mdExact acceptance check
This PowerShell block was run before and after the edit. The baseline exits
1with five expected failures. The final source exits0with12/12 passed; 0 failed. The text assertions verify explicit content and invariant routes; the source table above supplies the factual review.Other checks and results
git diff --check 0c67251812ea306543f3a14ab473ae357cfb76acgit diff --cached --checkgit diff --check 0c67251812ea306543f3a14ab473ae357cfb76ac...HEADe90ab70966ccfa12f7c20a486fb40f5846062c9a.git diff --name-only 0c67251812ea306543f3a14ab473ae357cfb76acAGENTS.mdandprofile/README.md.git diff --exit-code 0c67251812ea306543f3a14ab473ae357cfb76ac...HEAD -- .claude\CLAUDE.md .github\copilot-instructions.md README.md .github\CONTRIBUTING.md .github\pull_request_template.mdcurl.exe --fail --location --silent --show-error --max-time 60 --output NUL --write-out 'HTTP %{http_code}; URL %{url_effective}\n' 'https://msx.no/docs/'curl.exe --fail --location --silent --show-error --max-time 60 --output NUL --write-out 'HTTP %{http_code}; URL %{url_effective}\n' 'https://github.com/MSXOrg/.github'git --no-pager status --shortBoth HTTP destinations were also read to confirm the expected content, not only a successful status. The profile uses an absolute repository link so it reaches the same context from both the organization profile and the repository view.
The following GitHub GFM render commands succeed for the final source. Shape assertions confirm one H1, two paragraphs, and two canonical links for the profile; one H1 and one two-step ordered list for
AGENTS.md. The wrapper-resolution command returns the same rootAGENTS.mdfor both paths.Markdown/link lint was not run: the baseline has no corresponding scripts, shared Markdown configuration, package manifest, or workflow directory. The availability probe finds no installed
markdownlint-cli2,markdownlint, orpymarkdowncommand. No dependency is installed. Unmerged #12 is not treated as installed or enforced validation.The probe reports all three commands unavailable. The tracked-file query returns no matches. The local/manual checks above are evidence for this delivery, not installed CI enforcement.
Standards and framework alignment
The final pass checks the applicable pinned process and writing sources against the whole diff. No mission, guarantee, policy, enforcement mechanism, or response promise is added.
profile/README.mdAGENTS.mdConvergence, plan, and review
The scoped convergence command is:
It returns delivery leaves #16, #17, and #18. The two-file diff satisfies only #17. The form and reporting-policy asks are not satisfied by this change, so no additional closing reference is added. The native blocked-by query returns an empty list.
The issue plan records source review, small commits, early draft creation, factual and route checks, and validation evidence. This PR carries the final alignment, convergence, and review record.
The explicit command
gh pr edit 20 --repo MSXOrg/.github --add-reviewer '@copilot'succeeds after the final push. The final-source review is APPROVED fore90ab70966ccfa12f7c20a486fb40f5846062c9a, with zero inline comments and no active review issues. Its remote review check completed withsuccess. This is a review result, not a Markdown/link CI result.Historical original draft-delivery checkpoint: The PR was open and draft, assigned to its author. GitHub auto-merge was
null; Agent merge was disabled and its merge action was false. No merge or merge-automation change was made at that checkpoint. Current lifecycle: The PR is open and ready for review. Maintenance Agent merge is enabled withmerge_pr=false; GitHub auto-merge remainsnull. The user's direction is to merge changes as they are ready. The exclusive global merge slot is not yet granted. Merge remains on hold until root grants that slot and normal protected exact-head and native prerequisites are met. The repository has no versioned producer route in this source tree, so no release decision block or release label is added.Relevant issues (or links)
Resolves #17.
References MSXOrg/.github#12 for the separate, unmerged Markdown validation work. Its check is not installed on this PR's baseline.