Skip to content

fix(docs): deploy the docs site for this fork, not upstream's domain - #12

Merged
Elektr0Vodka merged 1 commit into
mainfrom
Fix/docs-pages-deploy
Oct 16, 2026
Merged

Elektr0Vodka merged 1 commit into
mainfrom
Fix/docs-pages-deploy

Conversation

@Elektr0Vodka

Copy link
Copy Markdown
Owner

What changed

  • .github/workflows/github-pages.yml: drop cname: docs.meshcore.nz. Every deploy wrote upstream's custom domain into gh-pages as a CNAME file.
  • mkdocs.yml: site_name, site_url, site_description, repo_name and repo_url now point at this fork (elektr0vodka.github.io/meshcomod) instead of meshcore-dev.
  • docs/index.md: the Documentation Source link points at this repo.
  • changelog_ev.md: entry for the fix, and PR numbers on the docs: add fork changelog, README fork status and docs dark theme #11 entries.

Why

The mkdocs site (with the dark theme from #11) never showed on https://elektr0vodka.github.io/meshcomod/. Pages is set to serve main /docs through Jekyll, so the mkdocs output on gh-pages is ignored. Pointing Pages at gh-pages while that branch carries upstream's CNAME would move the site to docs.meshcore.nz, so the CNAME has to go first.

After this merges and the workflow redeploys gh-pages without the CNAME, the Pages source needs to be switched to the gh-pages branch, root folder (repo setting, not part of this diff).

Testing

  • mkdocs build succeeds; the output has no CNAME and the canonical URL is https://elektr0vodka.github.io/meshcomod/.

Firmware or build impact

None. Docs site config only.

The Pages workflow still passed cname: docs.meshcore.nz, so every deploy wrote upstream's custom domain into gh-pages, and mkdocs.yml pointed site_url and repo_url at meshcore-dev. Drop the cname and point the site at elektr0vodka.github.io/meshcomod.
@Elektr0Vodka
Elektr0Vodka merged commit f7e7184 into main Oct 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant