You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Publishing to GitHub Pages turns these into a browsable, searchable site without requiring users to read raw markdown on GitHub.
Three implementation options; Option B is recommended:
Option A — Zero-config Jekyll (minimal effort)
Enable Pages from the main branch /docs folder in repo Settings. Accepts GitHub's default Cayman theme. Smallest possible PR but no sidebar navigation or search.
Option B — Themed Jekyll (RECOMMENDED)
Add docs/_config.yml with the just-the-docs theme (provides sidebar navigation + built-in search). Add a minimal Gemfile. Deploy via a pages.yml workflow using actions/configure-pages + actions/deploy-pages. No non-Go tooling required at runtime; GitHub-hosted runners handle the Jekyll build. Well-supported and polished output.
Option C — MkDocs or Hugo
Richer navigation/search but introduces a non-Go build dependency and ongoing maintenance burden. Not recommended unless the team already uses one of these.
The implementer should choose Option B unless they have a strong reason to deviate — the issue body should be updated with a comment explaining any alternative choice.
Acceptance
Pages site is reachable at https://lugassawan.github.io/rimba (or a configured custom domain)
README.md, docs/commands.md, and docs/configuration.md all render without broken links
Build runs automatically in CI on every push to main
No docs/ content is lost or broken relative to the current markdown files
Option B (themed Jekyll with just-the-docs) is implemented, or an alternative is justified in the PR description
Type
.github/workflows/, actions).goreleaser.yaml,scripts/)Files to change
.github/workflows/pages.yml(new) — build + deploy workflowdocs/_config.ymlormkdocs.yml(new, depending on option chosen)docs/if the chosen tool expects a specific layoutDescription
rimba already has substantial markdown ready to publish:
docs/commands.md(~22 KB) — full command referencedocs/configuration.md(~5.8 KB) — settings referenceREADME.md— project overview and quickstartPublishing to GitHub Pages turns these into a browsable, searchable site without requiring users to read raw markdown on GitHub.
Three implementation options; Option B is recommended:
Option A — Zero-config Jekyll (minimal effort)
Enable Pages from the
mainbranch/docsfolder in repo Settings. Accepts GitHub's default Cayman theme. Smallest possible PR but no sidebar navigation or search.Option B — Themed Jekyll (RECOMMENDED)
Add
docs/_config.ymlwith thejust-the-docstheme (provides sidebar navigation + built-in search). Add a minimalGemfile. Deploy via apages.ymlworkflow usingactions/configure-pages+actions/deploy-pages. No non-Go tooling required at runtime; GitHub-hosted runners handle the Jekyll build. Well-supported and polished output.Option C — MkDocs or Hugo
Richer navigation/search but introduces a non-Go build dependency and ongoing maintenance burden. Not recommended unless the team already uses one of these.
The implementer should choose Option B unless they have a strong reason to deviate — the issue body should be updated with a comment explaining any alternative choice.
Acceptance
https://lugassawan.github.io/rimba(or a configured custom domain)README.md,docs/commands.md, anddocs/configuration.mdall render without broken linksmaindocs/content is lost or broken relative to the current markdown filesjust-the-docs) is implemented, or an alternative is justified in the PR description