Skip to content

Set up MkDocs documentation and wire into Github Pages #21

Merged
ajtritt merged 2 commits into
mainfrom
ci-mkdocs
Jun 22, 2026
Merged

Set up MkDocs documentation and wire into Github Pages #21
ajtritt merged 2 commits into
mainfrom
ci-mkdocs

Conversation

@ajtritt

@ajtritt ajtritt commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add MkDocs (Material theme) documentation site with full navigation structure covering architecture, MCP servers, knowledge base, tools/skills, observability, CLI reference, and use cases.
  • Add GitHub Actions workflow that builds docs on every push/PR and deploys to GitHub Pages (gh-pages branch) on merges to main.
  • Add docs dependency group to pyproject.toml with mkdocs-material>=9.5.

Files Added

mkdocs.yml                          # MkDocs config (Material theme, nav, extensions)
docs/index.md                       # Home: overview, supported agents, key capabilities
docs/quickstart.md                  # Quick start walkthrough and setup-kb guide
docs/architecture.md                # Architecture diagram and layer descriptions
docs/mcp-servers.md                 # Registry and Knowledge server tool tables
docs/knowledge-base.md              # Six collections, explicit/episodic memory, search
docs/tools-skills.md                # Tool spec format, bundled tools, skills system
docs/observability.md               # MLflow, trace coverage by agent, provenance
docs/cli.md                         # Complete CLI reference table
docs/developer.md                   # Tests, proxy mode, troubleshooting
docs/assets/architecture.png        # Architecture image (copied from latex/)
docs/use-cases/index.md             # Use cases overview table
docs/use-cases/microbial-isolates.md
docs/use-cases/cryoem.md
docs/use-cases/vasp.md
.github/workflows/docs.yml          # Build on push/PR; deploy to gh-pages on main

Test Plan

  • Verify pip install mkdocs-material && mkdocs build --strict completes without errors.
  • Confirm the GitHub Actions docs job passes on this PR.
  • After merge, go to Settings → Pages → Source and select "Deploy from a branch" with gh-pages / / (root). Verify the deployed site renders correctly.

🤖 Generated with Claude Code

ajtritt added 2 commits June 16, 2026 15:29
 - Added Claude-generated content as a start
@ajtritt ajtritt merged commit edaef99 into main Jun 22, 2026
1 check passed
@ajtritt ajtritt deleted the ci-mkdocs branch June 22, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants