Add Hugo documentation site#80
Merged
Merged
Conversation
Documentation site under docs/, built on the kotlin-docs-kit Hugo theme module (pinned to hugo-v0.1.0). Covers getting started, the DOM, On-Demand and serialization guides, and a worked example. Publishes to GitHub Pages via .github/workflows/docs.yml on release or manual dispatch; test.yml skips docs-only changes.
There was a problem hiding this comment.
Pull request overview
Adds a Hugo-based documentation site under docs/ (using the kotlin-docs-kit theme module) and a GitHub Actions workflow to build/deploy it to GitHub Pages, while skipping CI tests for docs-only changes.
Changes:
- Introduce Hugo site configuration and content pages under
docs/. - Add
docs.ymlworkflow to build the site and deploy to GitHub Pages on release/manual dispatch. - Update
test.ymlto ignore docs-only changes.
Reviewed changes
Copilot reviewed 15 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/hugo.toml | Hugo site configuration (module import, outputs, menus, markup). |
| docs/go.mod | Go module pinning for the Hugo theme module (used by Hugo Modules). |
| docs/go.sum | Dependency checksums for the Hugo theme module. |
| docs/.gitignore | Ignore Hugo build artifacts. |
| docs/content/_index.md | Docs homepage content. |
| docs/content/getting-started/_index.md | “Getting started” section landing page. |
| docs/content/getting-started/installation.md | Installation and requirements guide. |
| docs/content/getting-started/quickstart.md | Quickstart guide for DOM and On-Demand. |
| docs/content/guides/_index.md | Guides section landing page. |
| docs/content/guides/dom.md | DOM API guide. |
| docs/content/guides/on-demand.md | On-Demand API guide. |
| docs/content/guides/serialization.md | kotlinx.serialization integration guide. |
| docs/content/examples/_index.md | Examples section landing page. |
| docs/content/examples/twitter.md | Worked example comparing APIs on twitter.json. |
| .github/workflows/docs.yml | New workflow to build Hugo site and deploy to GitHub Pages. |
| .github/workflows/test.yml | Skip test workflow runs when only docs/** changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,5 @@ | |||
| module github.com/devcrocod/simdjson-kotlin/docs | |||
|
|
|||
| go 1.26.4 | |||
|
|
||
| go 1.26.4 | ||
|
|
||
| require github.com/devcrocod/kotlin-docs-kit/packages/hugo v0.0.0-20260621234919-def8378dca04 // indirect |
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.
Documentation site under
docs/, built on the kotlin-docs-kit Hugo theme module (pinned tohugo-v0.1.0).docs.ymlon release or manual dispatchtest.ymlskips docs-only changesOne-time setup: Settings → Pages → Source = GitHub Actions.