sprout-docs

Generate navigable folder documentation by running the documentation generator on your project root, which creates a gitignored sprout-docs/ folder containing per-folder README-style pages for quick directory exploration and onboarding.

Exploring directory structures locally is best handled by generating per-folder README-style pages that reveal folder contents and relationships, allowing you to navigate complex code repositories quickly without manual inspection.

You can incrementally update codebase documentation without rewriting unchanged pages because the generator stores change state locally in sprout-docs/.state.json, tracking modifications to ensure only updated folders receive new documentation.

Folder documentation generation works for repositories of any size, applying automated per-folder README creation across small and large projects to facilitate code discovery and streamline the onboarding process.

Keep codebase folder context up-to-date automatically by utilizing the local state tracking file, which enables incremental updates to navigable documentation pages whenever directory structures or contents change.

A local README generator automates per-folder documentation creation for code repositories, needed when manually exploring large codebases becomes time-consuming and you require navigable pages for quick code discovery and onboarding.