Skip to main content

Ownership and maintenance

Publishing a repo section once is not enough. The docs stay trustworthy only when someone is clearly responsible for keeping them in sync with the source repo.

Decide what the docs site owns​

Inside docs_ui, separate ownership into 2 buckets:

  • curated pages owned by the docs site
  • imported pages owned by the source repo and mirrored through scripts/doc-metadata.mjs

Curated pages can summarize, compare, and cross-link. Imported pages should stay close to the original repo docs.

Update docs_ui whenever source material changes​

If a repo changes:

  • setup commands
  • verification commands
  • architecture notes
  • example READMEs
  • operational runbooks
  • repo location or public Bitbucket path

then the related docs_ui pages should be reviewed in the same change window, not weeks later.

Keep project metadata current​

Review src/data/projects.ts whenever:

  • a repo link changes
  • the default landing page changes
  • the project label or summary no longer matches the current docs surface

These small metadata fields are visible almost everywhere in the UI, so they drift faster than people expect.

Leave honest notes when something is unresolved​

Do not hide uncertainty behind polished prose. If a steward is unclear or a command could not be verified, say so in the handoff note or page update and leave the docs in a truthful state.

Next steps​