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

Publish docs to wuming.marvin8.zone via grebedoc #30

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

WuMing has MkDocs documentation but it is not currently published anywhere accessible. We want to serve it at https://wuming.marvin8.zone using grebedoc.dev, which hosts the pages branch of a Codeberg repository as a static site.

WuMing has MkDocs documentation but it is not currently published anywhere accessible. We want to serve it at https://wuming.marvin8.zone using grebedoc.dev, which hosts the `pages` branch of a Codeberg repository as a static site.
coding-agent-marvin8 commented 2026-06-26 03:07:54 +00:00 (Migrated from codeberg.org)
Copy link

Three repo changes are needed:

Findings: grebedoc serves the pages branch as a static website. The current MkDocs setup uses mike for versioned docs, but mike defaults to pushing to gh-pages. Also, site_url in mkdocs.yml currently points to the Codeberg repo URL rather than the docs domain.

Plan:

  1. mkdocs.yml — update site_url to https://wuming.marvin8.zone (fixes canonical URLs and sitemap).
  2. mkdocs.yml — add branch: pages to the mike plugin config so mike pushes built HTML to the pages branch that grebedoc expects.
  3. New .woodpecker/docs.yml — pipeline that runs on release/tag events, calls mike deploy with the release version and updates the latest alias, then pushes the pages branch to the remote.

DNS setup (outside the repo): TXT record at _git-pages-repository.wuming.marvin8.zone for domain ownership verification, plus A/AAAA or CNAME pointing to grebedoc.dev.

Three repo changes are needed: **Findings:** grebedoc serves the `pages` branch as a static website. The current MkDocs setup uses `mike` for versioned docs, but mike defaults to pushing to `gh-pages`. Also, `site_url` in `mkdocs.yml` currently points to the Codeberg repo URL rather than the docs domain. **Plan:** 1. `mkdocs.yml` — update `site_url` to `https://wuming.marvin8.zone` (fixes canonical URLs and sitemap). 2. `mkdocs.yml` — add `branch: pages` to the mike plugin config so mike pushes built HTML to the `pages` branch that grebedoc expects. 3. New `.woodpecker/docs.yml` — pipeline that runs on release/tag events, calls `mike deploy` with the release version and updates the `latest` alias, then pushes the `pages` branch to the remote. DNS setup (outside the repo): TXT record at `_git-pages-repository.wuming.marvin8.zone` for domain ownership verification, plus A/AAAA or CNAME pointing to grebedoc.dev.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
pages
feat/issue-57-ci-container-publish
feat/issue-53-review-quality
0.8.0
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.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/wuming#30
No description provided.