docs: add Hugo-based user manual published to GitHub Pages#24
Merged
Conversation
Add a project documentation website under docs/, built with Hugo and the hugo-book theme (vendored as a git submodule), following Apache Flink's docs approach. A new .github/workflows/docs.yml workflow builds the site and deploys it to GitHub Pages on pushes to main that touch docs/. The manual covers getting started, installation/downloads, concepts & architecture, the CLI, the S3 gateway, operations, and a configuration reference. Maven Central coordinates and GitHub Release downloads are marked as placeholders since nothing is published yet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MrEvU2tM8JaoZQgXotaPhH
✅ S3 compatibility gate passed
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24 +/- ##
=========================================
Coverage 83.66% 83.66%
Complexity 677 677
=========================================
Files 161 161
Lines 8876 8876
Branches 1330 1330
=========================================
Hits 7426 7426
Misses 970 970
Partials 480 480 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
Adds a source-controlled project documentation website that is automatically published to GitHub Pages.
Changes
docs/— a Hugo site using thehugo-booktheme, with sidebar navigation, client-side search, dark mode, and "Edit this page" links back to the source. The theme is vendored as a git submodule (docs/themes/hugo-book, pinned to v0.14.0).OPERATIONS.md, and design docs..github/workflows/docs.yml— builds the site (Hugo extended 0.158.0, the theme's minimum) and deploys it to GitHub Pages on pushes tomainthat touchdocs/**, plus manual dispatch. Uses the official GitHub Pages Actions.docs/README.md— how to preview and build the site locally.README.md— adds a docs-website badge..gitignore— ignores Hugo build output (docs/public/,docs/resources/).Notes
me.predatorray.candybox:candybox-client:0.1.0) as placeholders with a build-from-source fallback. The already-published Docker image is presented as the real install path.main; this PR's checks do not publish.--recurse-submodules(orgit submodule update --init) — documented indocs/README.md.Builds cleanly with Hugo 0.158.0 (27 pages, no warnings or errors).
🤖 Generated with Claude Code