Skip to content

docs: restructure documentation for mkdocs and add material theme - #24

Merged
laceyp99 merged 5 commits into
mainfrom
docs/update-agent-instructions
Sep 5, 2026
Merged

laceyp99 merged 5 commits into
mainfrom
docs/update-agent-instructions

Conversation

@laceyp99

@laceyp99 laceyp99 commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Update the AGENTS.md to best prompt agents on how to work within this repo.
  • Restructure repository documentation from a monolithic README.md into an organized MkDocs site located in docs/ (index.md, getting-started.md, usage.md, audio-and-data.md, development.md).
  • Add MkDocs Material configuration (mkdocs.yml) with light/dark palettes, navigation tabs, sticky headers, and theme assets (docs/assets/icon.png).
  • Add the docs extra (mkdocs-material>=9.6,<10) to pyproject.toml and update uv.lock.
  • Keep README.md focused on quick start, high-level features, and pointers to the MkDocs documentation.
  • Add site/ to .gitignore.

Testing

  • uv run --locked --extra dev --extra docs ruff format --check . (passed)
  • uv run --locked --extra dev --extra docs ruff check . (passed)
  • uv run --extra docs mkdocs build (built site successfully)
  • uv run --locked --extra dev pytest -q (42 passed, 1 skipped)
  • uv build (built sdist and wheel successfully)

@laceyp99
laceyp99 marked this pull request as ready for review September 5, 2026 01:24
@laceyp99

laceyp99 commented Sep 5, 2026

Copy link
Copy Markdown
Owner Author

Update summary

  • Add Mermaid flowcharts for loop generation, Stop Waiting behavior, and data-directory precedence.
  • Enable Mermaid rendering in the MkDocs Material site through SuperFences.

Testing

  • uv run --locked --extra dev ruff format --check . - passed
  • uv run --locked --extra dev ruff check . - passed
  • uv run --locked --extra dev pytest -q - passed (42 passed, 1 skipped)
  • uv build - passed
  • uv run --locked --extra docs mkdocs build --strict - passed

@laceyp99 laceyp99 left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to merge! This follows the same structure as conductor-core documentation. Hopefully now this documentation best reflects human and agent use across the repo.

@laceyp99
laceyp99 merged commit 48c2102 into main Sep 5, 2026
4 checks passed
@laceyp99
laceyp99 deleted the docs/update-agent-instructions branch September 5, 2026 01:41
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.

1 participant