What problem does it solve?
Maintainers and operators often juggle dispersed repo-local documentation (runbooks, procedures, decisions, references, and folder-based sets). The Internal Docs Writer standardizes creation, organization, and archiving by defaulting new content to the docs/internal location and moving superseded material into the nearest archived/ folder.
Core Features & Use Cases
- Standardized locationing: automatically writes new docs under docs/internal and creates the folder if needed.
- Frontmatter enforcement: ensures each document includes created_on, last_modified, and status to reflect lifecycle.
- Archival discipline: automatically relocates archived content to the nearest archived/ path and preserves folder structures for future reference.
- Doc-set support: handles folder-based doc sets and supports runbooks, procedures, decision notes, onboarding guides, and references.
Quick Start
Create a new internal documentation file under docs/internal, applying the standard frontmatter and aligning content to source materials.