tomevault-io Documentation
When to update which docs.
Rules
Documentation changes should land in same commit as the code.
| Change | Update |
|---|---|
| New public API | README.md, docs, APIDocs.tsx |
| New private API | docs only |
| Schema change | docs/schema.md + migration |
| New feature | README.md or docs/ |
| New env var | .env.example + docs |
| User-facing page | docs + possible screenshots |
APIDocs
Update src/pages/APIDocs.tsx only for endpoints that are:
- Publicly accessible without auth
- Intended for external consumers
Don't update for private/authenticated endpoints.
Source: Computational-Rare-Disease-Genomics-WHG/RNUdb — distributed by TomeVault.