📖 [Docs]: Documentation repositories have one documentation root - #129
Merged
Marius Storhaug (MariusStorhaug) merged 2 commits intoAug 2, 2026
Merged
Conversation
The section answered which surface owns the docs per repository type, but not where content sits in the repo. Left open, content lands in the root and the root stops being readable. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
August 2, 2026 13:31
Marius Storhaug (MariusStorhaug)
deleted the
docs/127-documentation-root
branch
August 2, 2026 14:22
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 Repository Standard now says where documentation content belongs in a repository whose product is content. Previously it answered which surface owns the docs for modules, libraries, services, CLIs, applications, Actions, and reusable workflows — but for a documentation repository it stopped at "the published site is the product", leaving the placement of the content itself unstated.
New: A documentation repository has one documentation root
Content lives in one folder, never spread across the repository root.
docs/is the default; a generator's source root such assrc/docs/applies when the site tooling needs one. The repository root stays reserved for the README, the tooling, and the governance files.The practical effect is that a reader can tell content from machinery by looking at the root listing, without opening a folder:
Technical Details
One paragraph added to Product documentation defaults in
src/docs/Ways-of-Working/Repository-Standard.md, after the repository-type table. The table answers which surface owns the docs per type; the paragraph answers where content sits in the repository, which applies to every row.Both roots are named deliberately. This repository keeps its own content under
src/docs/because Zensical needs a source root, so naming onlydocs/would have made the standard disagree with the repository that publishes it.No new section, per Documentation Model — one fact in one place, in the section that already owns the topic.
The gap surfaced in practice. In Storhaug-ting/Kilden, a repository of external source material, each source was given a folder directly in the repository root. With one source it read fine; with twelve on the way the root became a mix of tooling, governance files, and content. It took a correction from the repository owner to move the material under
docs/— Storhaug-ting/Kilden#4 — which is the correction this paragraph is meant to make unnecessary next time.Implementation plan progress: the single task in #127 is complete.
Related issues