Add MkDocs documentation site

coding-agent-marvin8 commented

2026-07-10 20:52:22 +00:00

(Migrated from codeberg.org)

Closes #15

Adds a versioned MkDocs Material documentation site at https://kokopelli.marvin8.zone, following the zaojun pattern.

mkdocs.yml with Material theme, teal palette, kokopelli logo/favicon, mike versioning
Pages: Home, Installation, Configuration, Usage (keybindings + asciinema screencast placeholders), Changelog
asciinema-player 3.8.0 via unpkg CDN; init script uses Material's document$ observable
deploy-docs CI job: needs gitleaks + checks, runs on version tag pushes, uploads to grebedoc via git-pages/action@v2
Documentation URL in pyproject.toml [project.urls]
Links in README.md and CLAUDE.md

Prerequisites before first deploy: create the pages orphan branch in the Codeberg repo (see CI job comment).

Closes #15 Adds a versioned MkDocs Material documentation site at https://kokopelli.marvin8.zone, following the zaojun pattern. - mkdocs.yml with Material theme, teal palette, kokopelli logo/favicon, mike versioning - Pages: Home, Installation, Configuration, Usage (keybindings + asciinema screencast placeholders), Changelog - asciinema-player 3.8.0 via unpkg CDN; init script uses Material's document$ observable - deploy-docs CI job: needs gitleaks + checks, runs on version tag pushes, uploads to grebedoc via git-pages/action@v2 - Documentation URL in pyproject.toml [project.urls] - Links in README.md and CLAUDE.md **Prerequisites before first deploy:** create the `pages` orphan branch in the Codeberg repo (see CI job comment).

coding-agent-marvin8 commented

2026-07-10 21:11:18 +00:00

(Migrated from codeberg.org)

docs/javascripts/asciinema.js line 5

The asciinemaInitialized flag is set to 'true' before AsciinemaPlayer.create is called.

✅ Fixed in commit 49d6019 — flag is now set only after a successful AsciinemaPlayer.create call, inside a try-catch that prevents one failing player from breaking the rest of the loop.

[`docs/javascripts/asciinema.js` line 5](https://codeberg.org/marvin8/kokopelli/pulls/16#issuecomment-18970388) > The `asciinemaInitialized` flag is set to 'true' before `AsciinemaPlayer.create` is called. ✅ Fixed in commit `49d6019` — flag is now set only after a successful `AsciinemaPlayer.create` call, inside a try-catch that prevents one failing player from breaking the rest of the loop.

coding-agent-marvin8 commented

2026-07-10 21:11:24 +00:00

(Migrated from codeberg.org)

docs/javascripts/asciinema.js line 6

AsciinemaPlayer.create may throw an exception (e.g., invalid data, missing resources).

✅ Fixed in commit 49d6019 — AsciinemaPlayer.create is now wrapped in try-catch; errors are logged to the console and the loop continues to initialize remaining players.

[`docs/javascripts/asciinema.js` line 6](https://codeberg.org/marvin8/kokopelli/pulls/16#issuecomment-18970391) > `AsciinemaPlayer.create` may throw an exception (e.g., invalid data, missing resources). ✅ Fixed in commit `49d6019` — `AsciinemaPlayer.create` is now wrapped in try-catch; errors are logged to the console and the loop continues to initialize remaining players.

coding-agent-marvin8 commented

2026-07-10 21:15:08 +00:00

(Migrated from codeberg.org)

.forgejo/workflows/ci.yml line 111

The token reference '${{ forge.token }}' uses an uncommon context 'forge'.

🔴 Not actioned. ${{ forge.token }} is the correct Forgejo built-in context — the Forgejo equivalent of GitHub Actions' ${{ github.token }}. It is already used in the existing pr-review job in this same workflow (forgejo_token: ${{ forge.token }}). No secrets need to be added.

[`.forgejo/workflows/ci.yml` line 111](https://codeberg.org/marvin8/kokopelli/pulls/16#issuecomment-18971177) > The token reference '${{ forge.token }}' uses an uncommon context 'forge'. 🔴 Not actioned. `${{ forge.token }}` is the correct Forgejo built-in context — the Forgejo equivalent of GitHub Actions' `${{ github.token }}`. It is already used in the existing `pr-review` job in this same workflow (`forgejo_token: ${{ forge.token }}`). No secrets need to be added.

coding-agent-marvin8 commented

2026-07-10 21:15:15 +00:00

(Migrated from codeberg.org)

.forgejo/workflows/ci.yml line 138

Same token reference issue as line 111.

🔴 Not actioned — same reasoning as the comment on line 111. ${{ forge.token }} is the correct Forgejo built-in token context and is the intended mechanism here.

[`.forgejo/workflows/ci.yml` line 138](https://codeberg.org/marvin8/kokopelli/pulls/16#issuecomment-18971180) > Same token reference issue as line 111. 🔴 Not actioned — same reasoning as the comment on line 111. `${{ forge.token }}` is the correct Forgejo built-in token context and is the intended mechanism here.

coding-agent-marvin8 commented

2026-07-10 21:15:22 +00:00

(Migrated from codeberg.org)

.forgejo/workflows/ci.yml line 115

The Forgejo token is embedded directly in the git remote URL as part of the credential string.

🔴 Not actioned. This is the established pattern in this project (copied from the zaojun deploy-docs job). Forgejo Actions masks forge.token in log output, so the token will not appear in plain text. The git remote set-url step does not echo the URL to stdout in normal operation.

[`.forgejo/workflows/ci.yml` line 115](https://codeberg.org/marvin8/kokopelli/pulls/16#issuecomment-18971531) > The Forgejo token is embedded directly in the git remote URL as part of the credential string. 🔴 Not actioned. This is the established pattern in this project (copied from the zaojun `deploy-docs` job). Forgejo Actions masks `forge.token` in log output, so the token will not appear in plain text. The `git remote set-url` step does not echo the URL to stdout in normal operation.

forgejo-actions commented

2026-07-10 22:16:33 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2134 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 22:28:02 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2222 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 22:31:03 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2295 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 22:36:05 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2349 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 22:57:04 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2541 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 23:09:32 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2541 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 23:14:31 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2541 lines; limit is 2000). Please consider splitting it into smaller PRs.

forgejo-actions commented

2026-07-10 23:50:15 +00:00

(Migrated from codeberg.org)

This PR is too large to review automatically (2580 lines; limit is 2000). Please consider splitting it into smaller PRs.

Rows
Columns

Add MkDocs documentation site #16