Skip to content

ADR-0007: pykit's docs follow the shared rn-forge docs standard

Status: accepted (2026-09-26) · Scope: root and package documentation

Decision

pykit's docs/ uses the same areas, naming and status model as every repository kiln scaffolds: architecture/, guides/, runbooks/, releases/, specs/ and adr/, routed by _structure.md files and declared in docs/_areas.yml. Where pykit's structure is better, the standard changes for every repository; pykit does not diverge from it.

As a monorepo, pykit adds one layer: each package keeps its own docs/ with index.md, guides/ and a generated reference/, and builds as a standalone site that the root site includes. Cross-package material lives only in the root areas.

The rules live in docs/_structure.md and each area's _structure.md; this record says why pykit follows them.

Consequences

A reader or agent who knows one rn-forge repository finds their way around this one. An installed-package user finds the package's contract in its own site without reading monorepo governance. A change to the structure is a change to the standard, proposed for all repositories at once.

Influences

This decision shapes E10 documentation refactor and the root documentation index.

Alternatives considered

A pykit-only layout would drift from the repositories kiln scaffolds and make readers learn two models. Moving every package's pages into the root areas would break each package's standalone site.

Background

Proposed 2026-09-24 from the documentation structure review. Accepted 2026-09-26, when the owner set the goal of one docs structure across all rn-forge repositories; the same day, the package api/ directories became reference/ and web's adoption/ pages joined its guides/. Later that day pykit dropped its history area, which the standard does not have; superseded plans and review evidence live in Git history.