Fix agent onboarding doc gaps: missing CONTRIBUTING.md, broken link, missing examples#80
Closed
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Closed
Fix agent onboarding doc gaps: missing CONTRIBUTING.md, broken link, missing examples#80Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Member
Author
|
Superseded by #79 and #82, which independently merged to main and cover the same three gaps (CONTRIBUTING.md, broken Ways-of-Working link, agent onboarding examples) — using a cleaner approach (pointing to Template-PSModule as the live example instead of inline snippets). Closing as redundant; no unique changes remain in this branch. |
Marius Storhaug (MariusStorhaug)
deleted the
fix-agent-onboarding-doc-links
branch
July 25, 2026 13:47
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.
Why
Small gaps found while researching AGENTS.md routing guidance for PSModule module repositories:
AGENTS.md(and its counterpart in MSXOrg/docs) links toCONTRIBUTING.md, which didn't exist in this repo.Modules/Repository-Defaults.mdhad a broken relative link to../../Ways-of-Working/Git-Worktrees.md— that page actually lives in MSXOrg/docs.AGENTS.md/CLAUDE.md/copilot-instructions.mdpattern only in prose, with no copy-pasteable example — unlike the README section in the same file, which has full examples.What changed
CONTRIBUTING.mdat repo root: layout, contribution workflow (worktree/branch, draft PR, micro-commits), local build/preview (zensical build --clean), and linting (super-linter), all confirmed against.github/workflows/Docs.yml.Repository-Defaults.mdto point to the canonicalhttps://msxorg.github.io/docs/Ways-of-Working/Git-Worktrees/.AGENTS.md,CLAUDE.md, and.github/copilot-instructions.mdto the "Agent onboarding files" section, so module repositories (e.g.Template-PSModule) have something to copy directly.Docs-only change; no build/test tooling changes needed.