Skip to content

📖 [Docs]: Documentation repositories have one documentation root - #129

Merged
Marius Storhaug (MariusStorhaug) merged 2 commits into
mainfrom
docs/127-documentation-root
Aug 2, 2026
Merged

📖 [Docs]: Documentation repositories have one documentation root#129
Marius Storhaug (MariusStorhaug) merged 2 commits into
mainfrom
docs/127-documentation-root

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

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 as src/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:

.
├── README.md          ← start page
├── scripts/           ← tooling
└── docs/              ← the content

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 only docs/ 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

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>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 2, 2026 13:31
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit fdd7c06 into main Aug 2, 2026
19 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs/127-documentation-root branch August 2, 2026 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define where documentation content lives in a documentation repository

1 participant