marvin8/kokopelli
marvin8/kokopelli
Watch
1
0
Fork
You've already forked kokopelli
 0
Code Issues Pull requests Releases 4 Activity Actions

Add MkDocs documentation site #15

New issue
Closed
opened 2026-07-10 20:33:06 +00:00 by coding-agent-marvin8 · 1 comment
coding-agent-marvin8 commented 2026-07-10 20:33:06 +00:00 (Migrated from codeberg.org)
Copy link

Kokopelli has no documentation site. Add a versioned MkDocs Material site hosted at https://kokopelli.marvin8.zone on grebedoc.dev, published in CI on every release tag.

Includes:

  • mkdocs.yml with Material theme, mike versioning, kokopelli logo/favicon
  • Pages: Home, Installation, Configuration, Usage (keybindings + asciinema screencasts), Changelog
  • asciinema-player integration via unpkg CDN with a small JS init script
  • deploy-docs CI job in .forgejo/workflows/ci.yml
  • Documentation URL in pyproject.toml [project.urls]
  • Links in README.md and CLAUDE.md
  • PR on marvin8-website to add the docs link to marvin8.zone
Kokopelli has no documentation site. Add a versioned MkDocs Material site hosted at https://kokopelli.marvin8.zone on grebedoc.dev, published in CI on every release tag. Includes: - mkdocs.yml with Material theme, mike versioning, kokopelli logo/favicon - Pages: Home, Installation, Configuration, Usage (keybindings + asciinema screencasts), Changelog - asciinema-player integration via unpkg CDN with a small JS init script - deploy-docs CI job in .forgejo/workflows/ci.yml - Documentation URL in pyproject.toml [project.urls] - Links in README.md and CLAUDE.md - PR on marvin8-website to add the docs link to marvin8.zone
coding-agent-marvin8 commented 2026-07-10 20:33:28 +00:00 (Migrated from codeberg.org)
Copy link

Plan of attack:

  1. Add mkdocs, mkdocs-material, mike to dev group in pyproject.toml
  2. Create mkdocs.yml (Material theme, mike plugin, kokopelli logo/favicon, asciinema-player CDN)
  3. Create docs/ tree: stub pages for all nav entries, docs/images/ with icon copies, docs/javascripts/asciinema.js, docs/casts/.gitkeep
  4. Fill in full content for all doc pages
  5. Add deploy-docs job to .forgejo/workflows/ci.yml
  6. Add [project.urls] Documentation entry, update README.md and CLAUDE.md
  7. Open kokopelli PR and a separate marvin8-website PR
Plan of attack: 1. Add mkdocs, mkdocs-material, mike to dev group in pyproject.toml 2. Create mkdocs.yml (Material theme, mike plugin, kokopelli logo/favicon, asciinema-player CDN) 3. Create docs/ tree: stub pages for all nav entries, docs/images/ with icon copies, docs/javascripts/asciinema.js, docs/casts/.gitkeep 4. Fill in full content for all doc pages 5. Add deploy-docs job to .forgejo/workflows/ci.yml 6. Add [project.urls] Documentation entry, update README.md and CLAUDE.md 7. Open kokopelli PR and a separate marvin8-website PR
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
pages
0.6.2
0.6.1
0.6.0
0.5.1
0.5.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
marvin8/kokopelli#15
No description provided.