Restructure docs into a domain x type model#5
Merged
Conversation
…tting it Commit conventions, bug/feature reporting, and PR process move back into CONTRIBUTING.md and stay there, matching how CODE_OF_CONDUCT.md and SECURITY.md are already treated: content stays at the GitHub-fixed path, the grid links to it rather than absorbing it. GitHub surfaces CONTRIBUTING.md directly when a contributor opens a PR or issue, so splitting it into docs/team-process added a click at exactly the moment someone needs the answer fastest.
…on entry The Development section's placeholder commands were pure duplication of docs/product-code/tutorials/getting-started.md's Common Commands section and were correctly dropped during the restructure, but the Table of Contents still linked to it. Also add the Documentation section, which existed but was never listed.
|
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
1 participant
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.
Summary
docs/getting-started/+docs/developer-guide/layout with a domain (product-code / operations / team-process / organizational) x type (concept / how-to / reference / decisions / tutorials / runbooks) structure, indexed bydocs/README.md.env.example, and a CI/CD pipeline doc describing the actualci.yml/release.yml/commitlint.yml/dependabot.ymlconfigtodo_*.mdplaceholder files (with the right frontmatter/skeleton) for grid cells a template genuinely can't fill in yet — architecture overview, first decision record, deployment runbook, tool inventory, role charter, tooling-choice decisionREADME.md/CONTRIBUTING.mdbecome thin entry points into the new docs tree instead of duplicating content; GitHub-native fixed-path files (CODE_OF_CONDUCT.md,SECURITY.md,LICENSE,.github/CODEOWNERS) are untouched.github/SUPPORT.mdleft over from the old structuretodo_*.mdfiles, in both.githooks/pre-pushand a new independentdocs-todo-checkCI job — mirrors the existing local-hook + CI-backstop pattern already used for commit-msg validationTest plan
docs/README.mdand confirm every linked file exists and rendersgetting-started.md,code-style.md, and the newREADME.md/CONTRIBUTING.mdentry pointsdocs/getting-started/anddocs/developer-guide/are gone with no remaining references anywhere in the repopre-pushhook lists thetodo_*.mdfiles without blocking the pushdocs-todo-checkCI job runs and posts warnings without failing the build