docs: polish README and publish MkDocs site to GitHub Pages#19
Merged
Conversation
- Rewrite README with hero, badges, and docs link - Add MkDocs-Material site under docs/ (7 pages) - Add GitHub Actions workflow to build and deploy docs to Pages - Ignore mkdocs build output (site/)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
campy.gif), CI/MIT/bun/docs badges, and full sections (Features, both install options, per-agent table, slash commands, pets, file structure, License).docs/with 7 pages (index, installation, agents, commands, pets, architecture, contributing) — Material theme, light/dark toggle, search, code-copy..github/workflows/docs.ymlbuilds the site and deploys to GitHub Pages (official Pages actions; runs on push tomainfor docs paths + manualworkflow_dispatch)..gitignore: ignore localsite/build output.Verification
bun run typecheckcleanbun test— 43 pass / 0 faildocs.ymlparses as valid YAMLdocs/superpowers/left untouchedManual follow-up (repo settings)
maindeploy or a manual workflow run.