auggie-deep-wiki

Generate MDX documentation for a Git repository automatically by orchestrating the auggie CLI across metadata, structure, and per-section content. This process clones and indexes the repo, then assembles a navigable wiki.mdx file with Mermaid diagrams.

Creating a navigable wiki from an existing codebase is best done by automating wiki structure generation and per-section MDX assembly. This approach yields a consistent, DeepWiki-style reference that eliminates manual, error-prone documentation.

You need Python 3.10+, auggie, and git to generate MDX wiki guides. Node.js and npm are optional dependencies required only for MDX validation and building the host Astro site for publishing.

You can validate MDX files before publishing a generated repository wiki using the optional Node-based validation. This step catches MDX issues early, ensuring the wiki is structurally sound before pushing it to a host Astro site.

View a generated MDX wiki locally without a full site build by producing a self-contained index.html viewer. Alternatively, you can serve the wiki live via a small HTTP server for local viewing.

Automated wiki generation works with Mermaid diagrams in MDX by orchestrating the auggie CLI across metadata, structure, and per-section content. It yields a consistent, navigable reference that includes these diagrams natively.