Add Hugo + Hextra documentation site under docs/#1
Merged
Conversation
Build a self-contained Hugo site in docs/ (its own module, isolated from the app's go.mod) and publish it to GitHub Pages at antonkomarev.github.io/certel. - Move existing docs into docs/content/ (metrics, alternatives, ADRs) and the DBML schema into docs/static/; add front-matter (title/weight) to each page. - Add a link render hook so the ADRs' relative .md cross-links resolve, since Hextra ships none; repoint out-of-site links (README, config, schema) to GitHub. - Add a landing page and a Pages deploy workflow (.github/workflows/docs.yml). - Point the four README doc links at the published site / new file locations.
- Trigger the Docs workflow on pull_request too; gate the deploy job to non-PR events so PRs validate the build without publishing. - Add --panicOnWarning so an unresolved cross-link (render-link hook warning) fails the build instead of shipping. - Add Dependabot for github-actions and the docs Hugo module (Hextra).
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
1 participant
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
Adds a self-contained Hugo + Hextra documentation site under
docs/, published to GitHub Pages athttps://antonkomarev.github.io/certel/.The Hugo site lives entirely inside
docs/with its own module (docs/go.mod), isolated from the application's rootgo.mod— no build interference.Changes
docs/content/:metrics.md,alternatives.md, and all ADRs (git mv, history preserved); DBML schema →docs/static/schema.dbml.title/weight) added to every page; ADR body# H1folded intotitleto avoid a double heading under Hextra.docs/layouts/_default/_markup/render-link.html) — Hextra 0.12.3 ships none, so bare relative.mdcross-links (ADR↔ADR) would 404; the hook resolves them. Out-of-site links (README,config.example.yaml,schema.dbml) repointed to GitHub.docs/content/_index.md) with section cards..github/workflows/docs.yml) — Hugo extended build + Pages deploy, triggered ondocs/**;--baseURLfromconfigure-pages.docs/.gitignorefor Hugo build artifacts (public/,resources/,.hugo_build.lock).Builds locally clean: 32 pages, 0 warnings, all links resolve.
Required one-time setup after merge
Repo Settings → Pages → Build and deployment → Source =
GitHub Actions— otherwise the deploy job cannot publish.Local preview