Skip to content

docs: add mkdocs #9

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
merged 2 commits into from
Oct 31, 2025
Merged

docs: add mkdocs #9

merged 2 commits into from
Oct 31, 2025

Conversation

@gadomski
Copy link
Collaborator

@gadomski gadomski commented Oct 24, 2025 •
edited
Loading

Adds:

  • CI with simple linting
  • Pages workflow for deploying on tag push. Note that this won't deploy anything for now, we'll have to manually backfill the old versions

cc @hrodmn

Closes #8

@gadomski gadomski self-assigned this Oct 24, 2025
@gadomski gadomski requested a review from hrodmn October 27, 2025 16:21
hrodmn
hrodmn reviewed Oct 31, 2025
View reviewed changes
Copy link
Collaborator

@hrodmn hrodmn left a comment

Choose a reason for hiding this comment

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

This looks great! Unless you want to fill out more details or context in the existing index.md my preference would be to just have the spec be the landing page. That's what people are going to want to read when they get to this site.

@gadomski gadomski requested a review from hrodmn October 31, 2025 14:22
@gadomski gadomski merged commit ea9f4eb into main Oct 31, 2025
1 check passed
@gadomski gadomski deleted the issues/8-docs branch October 31, 2025 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hrodmn hrodmn hrodmn approved these changes

Assignees

@gadomski gadomski

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Deploy a documentation site

3 participants

@gadomski @hrodmn