Author-facing vs generated-project documentation split#29
Merged
Conversation
Relocate ADR 0015 (Copier engine — a template-authoring decision) to a root author-facing docs/adr/ with its own registry; the generated standard in template/docs/adr/ drops it (the validator allows the resulting numbering gap). Reframe generated docs so a scaffolded project reads as itself rather than "Cosmic FastAPI" (ADR 0001 intro, ADR registry intro, migrations README, .gitignore comment, and the generated README's logo/links/TOC). Move the logo asset to author-facing root; add a root CONTRIBUTING.md describing the author-vs-generated model and how to evolve the standard. The bake matrix now also runs adr-check in each generated project. Closes #23 Refs #24 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
17 tasks
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.
Author-facing vs generated-project documentation split (#23)
Final Phase-1 cleanup of epic #24 — separates docs about the template itself from docs that ship into a generated project.
docs/adr/with its own registry README. The generated standard (template/docs/adr/) drops it; the validator has no contiguity rule, so the 0014→0016 gap is fine (18 records, 15 active)..gitignorecomment, and the generated README (removed the kangaroo logo, fixed the TOC anchor, and pointed the acknowledgement at the real upstream template repo instead of{{ github_owner }}).docs/; generated projects no longer ship it.CONTRIBUTING.mdadded: the author-vs-generated model, bake-and-test workflow, Copier variables/flags, the two ADR sets, and conventional commits.database × include_user_examplecombos now also runsadr-check.Validation
uv sync, ruff, ruff format, pyrefly, adr-check, and pytest at 100% coverage.template/docs/adr(18 records, 0015 gap) and rootdocs/adr(1 record).Closes #23
Refs #24
🤖 Generated with Claude Code