Repository navigation
Clean up the reader-facing pages before sharing - #46
Merged
Merged
Conversation
…ntent Before the repository is shared widely, the README, reading guide, module charters and indexes carried visible author notes, phase numbers, backlog IDs, and a status line written before any pattern now on main existed. Author notes move into HTML comments and a section that held only a note is hidden rather than filled. The metrics library index says what each page answers instead of where the drafting stands. The skills index, prior-art review, stubs and Module 1 charter drop phase and backlog references. The roadmap, changelog, README status and module status lines reflect what is on main. Contributing points at issues, since Discussions are not enabled, and its provenance rule matches what CI checks. The reference-architecture and guide indexes point at the roadmap instead of promising counts it disagreed with. The judgment calls are recorded in DECISIONS.md.
…he README had no bio link Conduct reports go through the repository's issue tracker, and the Contributor Covenant's two bracketed notes to the adopter are removed. The README author line links the maintainer's LinkedIn bio. LinkedIn joins the hosts the external link check skips, since it answers automated checkers with a refusal rather than a page.
Adds a CODEOWNERS file naming the maintainer for every path, so GitHub requests their review on each pull request and the branch ruleset on main can require that review before a merge.
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.
The pages a new reader lands on still read like my working notes. The README status predates every pattern now on main, the reading guide lists one pattern, three module charters show my to-do notes as page text, and the indexes report where each page stands in my drafting rather than what it is for. Phase numbers and backlog IDs leaked onto the skills index, the prior-art review and the stubs.
This pass makes those pages describe the content. My notes move into HTML comments, and a section that held only a note is hidden rather than filled. The status lines, the reading guide's list of what is available, the roadmap and the changelog now match what is on main. The metrics library index says what each page answers. CONTRIBUTING sends case studies to issues, since Discussions are off, and its provenance rule matches what CI checks. The code of conduct's two template notes are resolved, with reports going through the issue tracker. The README author line links my bio. A CODEOWNERS file requests my review on every pull request, which the ruleset on main will require. Smaller fixes ride along: a broken list on the skills index, the license line on the templates index, a stray
.gitkeep, the pattern-proposal template asking only about Module 1's halves, and LinkedIn added to the hosts the link checker skips.Files:
README.md,docs/index.md, and the four charters underdocs/modules/docs/metrics/README.md,docs/prior-art.md,skill/README.md,templates/README.md, and the two stubs with their indexes underreference-architectures/andimplementation-guides/CONTRIBUTING.md,CODE_OF_CONDUCT.md,.github/CODEOWNERS,.github/ISSUE_TEMPLATE/pattern-proposal.mdROADMAP.md,CHANGELOG.md,CONTENT_BACKLOG.md,DECISIONS.md,REFERENCES.md,lychee.toml,.gitignore