Features

Feature Docs

Docs HomeHome
This folder mirrors `features/` so people can move between code and docs with less guesswork.
DocsFeaturesFeature Docs

Feature Docs

This folder mirrors so people can move between code and docs with less guesswork.

How To Use These Docs

  • Start with the top-level feature README.md
  • Open nested docs when you need details about one part of the feature
  • Follow the "Related docs" links to move across feature boundaries

Writing Rules

  • Use simple English first
  • Explain the user-facing reason before the implementation
  • Keep one page focused on one area
  • Add file links when a page talks about real code
  • Update docs when behavior or structure changes in a meaningful way
  • Mirror the real folder structure when possible
  • Add nested pages for complex subfolders instead of growing one long page

Documentation System Goals

  • Help a new teammate understand a feature without reading every source file first
  • Help product and design discussions use the same language as the codebase
  • Keep architecture details close to the feature that owns them
  • Make future documentation updates feel routine instead of painful

Folder Design

This tree mirrors :

  • one top-level README.md per feature
  • nested docs for complex subfolders
  • one topic per page
  • short "Related docs" links to move across the system

If a feature grows a new important subfolder, the docs should grow with it.

Page Template

Each feature page should answer these questions:

  1. What is this feature?
  2. Why does it exist?
  3. What parts belong to it?
  4. What data does it use?
  5. What does the user see?
  6. What depends on it?
  7. What is unfinished or risky?

Use the style guide for the full template:

Top-Level Features