docs: add MkDocs Material documentation site#1424
Open
TimChild wants to merge 1 commit intoruvnet:mainfrom
Open
docs: add MkDocs Material documentation site#1424TimChild wants to merge 1 commit intoruvnet:mainfrom
TimChild wants to merge 1 commit intoruvnet:mainfrom
Conversation
- 17 pages covering getting started, architecture, agents, MCP, and configuration - MkDocs Material theme with dark/light mode - llms-source plugin generating /llms.txt and /llms-full.txt - GitHub Actions workflow for auto-deploy to GitHub Pages - docs-requirements.txt for reproducible builds
a260bcc to
31534a6
Compare
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
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.
Summary
Adds a complete MkDocs Material documentation site with 17 pages covering getting started, architecture, agents, MCP integration, and configuration. Includes a GitHub Actions workflow for automatic deployment to GitHub Pages.
What's included
/llms.txtand/llms-full.txtfollowing the llms.txt spec.github/workflows/docs.yml) for auto-deploy on push tomaindocs-requirements.txtfor reproducible buildsStructure
Build verification
mkdocs build --strictpasses with zero warningsllms.txtandllms-full.txtboth generate correctlyScreenshots
Homepage
Architecture (with Mermaid diagrams)
To deploy
After merging, enable GitHub Pages in the repo settings:
Settings → Pages → Source: GitHub Actions
The workflow will automatically build and deploy on every push to
main.Notes
docs-screenshots/directory is only for this PR preview and can be removed before or after merge