Skip to content

docs: add mkdocs documentation site #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jamiesun merged 1 commit into from
Oct 28, 2025
Merged

docs: add mkdocs documentation site #13

jamiesun merged 1 commit into from
Oct 28, 2025

Conversation

@jamiesun
Copy link
Contributor

@jamiesun jamiesun commented Oct 28, 2025

Summary

  • scaffold MkDocs documentation with guides, API reference, and troubleshooting content
  • add docs-specific requirements, Makefile targets, and setup script
  • configure GitHub Actions workflow to build and publish the documentation site

Testing

  • mkdocs build

@jamiesun jamiesun merged commit e228e62 into main Oct 28, 2025
7 checks passed
@jamiesun jamiesun deleted the feature/docs-website branch October 28, 2025 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jamiesun