Skip to content

Docs Ownership Rules

Use this checklist before adding or moving documentation.

ContentLocation
Host package contracts and extension pointscapell-4/docs or the owning host package docs
Host package implementation detailscapell-4/packages/<package>/docs
Companion package featurescapell-packages-4/packages/<package>/docs
Marketing, brand, website copy, or sales positioning/Users/ben/Sites/packages/capell/docs
Historical plans, audits, or internal review notesoutside public docs unless still actively useful
  • Update an existing page before adding a new file.
  • Every doc must be linked from docs/README.md, a section index, a package overview, or another doc.
  • Do not keep “moved” stubs unless an external published URL needs a temporary redirect.
  • Do not document optional package behavior as built-in host behavior.
  • Keep package-specific install commands in the package that owns them.
  • Prefer short task pages over broad narrative pages.
  • End leaf docs with a small Next section when there is a natural follow-up.
  • Who is the reader: installer, package author, operator, maintainer, or editor?
  • What is the next action after reading?
  • Is the command, class, config key, or package name current?
  • Does this duplicate another page?
  • Would this be better in a package README?