Skip to content

organize MkDocs documentation - #32

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

  • organize the README content into a Material for MkDocs documentation site
  • add focused getting-started, evaluation, analysis, development, and reference pages
  • add Mermaid diagrams and document the docs dependency group and local preview workflow
  • align AGENTS.md guidance with the new documentation structure

Testing

  • uv run --locked --all-extras ruff format --check . - passed
  • uv run --locked --all-extras ruff check . - passed
  • uv run --locked --group docs mkdocs build --strict - passed
  • uv run --locked --all-extras pytest -q - passed (130 tests)
  • uv build - passed

@laceyp99
laceyp99 marked this pull request as ready for review September 5, 2026 03:35

@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.

Finally looks good to merge! After manual cleaning for readability and linking to relevant commands and repo docs, now the repo is representable.

@laceyp99
laceyp99 merged commit a9b6261 into main Sep 5, 2026
2 checks passed
@laceyp99
laceyp99 deleted the docs/update-agent-instructions branch September 5, 2026 06:38
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