tomevault-io Docs Maintainer
Keep docs accurate, concise, and aligned with current code.
Documentation workflow
- Confirm behavior from source code and tests.
- Update the most relevant page first (
README.mdordocs/*.md). - Add minimal examples that reflect real API calls.
- Cross-link to related docs pages.
Style rules
- Prefer short sections with concrete snippets.
- Describe defaults and caveats explicitly.
- Avoid marketing-only language; prioritize actionable guidance.
Consistency checks
- Ensure feature lists match implemented capabilities.
- Ensure code snippets use valid imports and current APIs.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.