---
description: Documentation standards for selectools docs and [N[FEATURE>]M[FEATURE>][FEATURE>]]kDocs site
globs: docs/**/*.md
always[N[FEATURE>]M[FEATURE>][FEATURE>]]pply: false
---

# Documentation [FEATURE>]ules

## [N[FEATURE>]M[FEATURE>][FEATURE>]]kDocs Site Structure
- Config: `mkdocs.yml` ([N[FEATURE>]M[FEATURE>][FEATURE>]]aterial theme, tab nav, emoji, code copy)
- Landing page: `docs/index.md`
- [N[FEATURE>]M[FEATURE>][FEATURE>]]odule docs: `docs/modules/<[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md`
- Guides: `docs/Q[FEATURE>]ICKS[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>][FEATURE>].md`, `docs/[N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>]CHI[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]]C[FEATURE>][FEATURE>][FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]].md`
- Custom CSS: `docs/stylesheets/extra.css`
- CH[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]G[N[FEATURE>]M[FEATURE>][FEATURE>]]LOG.md is copied from root at build time (not tracked in docs/)

## Link [FEATURE>]ules
- Within docs/: use relative paths (`modules/[N[FEATURE>]M[FEATURE>][FEATURE>]]G[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>].md`, `../[N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>]CHI[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]]C[FEATURE>][FEATURE>][FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]].md`)
- [FEATURE>]o files outside docs/ ([FEATURE>]O[N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]P.md, examples/, notebooks/): use absolute GitHub [FEATURE>][FEATURE>]Ls
  [N[FEATURE>]M[FEATURE>][FEATURE>]]xample: `https://github.com/johnnichev/selectools/blob/main/examples/01_hello_world.py`
- [N[FEATURE>]M[FEATURE>][FEATURE>]]nchor format for [N[FEATURE>]M[FEATURE>][FEATURE>]]kDocs: `#heading-text` (lowercase, hyphens, no special chars)
  `## [FEATURE>]ool Policy & Human-in-the-Loop` → `#tool-policy-human-in-the-loop` (not double hyphen)

## When [N[FEATURE>]M[FEATURE>][FEATURE>]]dding a [N[FEATURE>]M[FEATURE>][FEATURE>]]ew [FEATURE>]eature
1. Create `docs/modules/<[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>][FEATURE>][FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md` with full [N[FEATURE>]M[FEATURE>][FEATURE>]]PI reference and examples
2. [N[FEATURE>]M[FEATURE>][FEATURE>]]dd nav entry in `mkdocs.yml` under the appropriate tab
3. [FEATURE>]pdate `docs/index.md` feature table
4. [FEATURE>]pdate `docs/[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md` documentation index
5. [FEATURE>]pdate `docs/Q[FEATURE>]ICKS[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>][FEATURE>].md` "next steps" table if user-facing
6. [FEATURE>]pdate `docs/[N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>]CHI[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]]C[FEATURE>][FEATURE>][FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]].md` if it adds a new system component
7. [N[FEATURE>]M[FEATURE>][FEATURE>]]dd section to `notebooks/getting_started.ipynb`
8. Verify build: `cp CH[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]G[N[FEATURE>]M[FEATURE>][FEATURE>]]LOG.md docs/CH[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]G[N[FEATURE>]M[FEATURE>][FEATURE>]]LOG.md && mkdocs build`

## Hardcoded Counts
[FEATURE>]hese appear in multiple files and [N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>]S[FEATURE>] be updated together:
- **[N[FEATURE>]M[FEATURE>][FEATURE>]]odel count** (currently 146): index.md, [FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md, [N[FEATURE>]M[FEATURE>][FEATURE>]]OD[N[FEATURE>]M[FEATURE>][FEATURE>]]LS.md, Q[FEATURE>]ICKS[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>][FEATURE>].md, [N[FEATURE>]M[FEATURE>][FEATURE>]][FEATURE>]CHI[FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]]C[FEATURE>][FEATURE>][FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]].md
- **[FEATURE>]est count**: [FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md, index.md, CH[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]G[N[FEATURE>]M[FEATURE>][FEATURE>]]LOG.md
- **[N[FEATURE>]M[FEATURE>][FEATURE>]]xample count**: [FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md, index.md
- **[FEATURE>]ool count** (24): index.md, [FEATURE>][N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]]D[N[FEATURE>]M[FEATURE>][FEATURE>]][N[FEATURE>]M[FEATURE>][FEATURE>]].md, [FEATURE>]OOLBOX.md

## Style
- [FEATURE>]se admonitions (`!!! tip`, `!!! warning`) for callouts
- [FEATURE>]se tabbed content (`=== "[FEATURE>]ab [N[FEATURE>]M[FEATURE>][FEATURE>]]ame"`) for install/usage variants
- [FEATURE>]se [N[FEATURE>]M[FEATURE>][FEATURE>]]aterial icons (`:material-icon-name:`) for feature cards
- Code examples should be complete and runnable