Repository navigation
fix(docs): deploy the docs site for this fork, not upstream's domain - #12
Merged
Merged
Conversation
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.
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
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 changed
.github/workflows/github-pages.yml: dropcname: docs.meshcore.nz. Every deploy wrote upstream's custom domain intogh-pagesas aCNAMEfile.mkdocs.yml:site_name,site_url,site_description,repo_nameandrepo_urlnow point at this fork (elektr0vodka.github.io/meshcomod) instead ofmeshcore-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/docsthrough Jekyll, so the mkdocs output ongh-pagesis ignored. Pointing Pages atgh-pageswhile that branch carries upstream'sCNAMEwould move the site todocs.meshcore.nz, so the CNAME has to go first.After this merges and the workflow redeploys
gh-pageswithout the CNAME, the Pages source needs to be switched to thegh-pagesbranch, root folder (repo setting, not part of this diff).Testing
mkdocs buildsucceeds; the output has noCNAMEand the canonical URL ishttps://elektr0vodka.github.io/meshcomod/.Firmware or build impact
None. Docs site config only.