docs: restructure into guides/reference and add a MkDocs Material site - #10
Merged
Conversation
Reorganize the documentation into a Diátaxis layout (tutorial / guides / explanation / reference) and publish it as a MkDocs Material site on GitHub Pages, with the library API reference generated from the source docstrings by mkdocstrings. - Trim README to a front page (description, install, common CLI, config intro, links to the site). - New pages: getting-started tutorial, CLI guide, conventions & glossary, complete configuration reference, output-format reference, library API reference. - Move architecture.md -> explanation/pipeline.md (reframed stage by stage), configuration.md / library.md -> guides/ (library folds in the old video.md). - Remove docs/comparison.md and docs/video.md. - Add mkdocs.yml, a `docs` dependency group, and a GitHub Pages deploy workflow. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganize the documentation into a Diátaxis layout (tutorial / guides / explanation / reference) and publish it as a MkDocs Material site on GitHub Pages, with the library API reference generated from the source docstrings by mkdocstrings.
docsdependency group, and a GitHub Pages deploy workflow.