Publish a documentation site - #15
Merged
Merged
Conversation
site/ is an mdBook: guide pages from the README's sections, pages on coding agents and troubleshooting, and rules, configuration and command-line reference pages generated from the binary, jevgate.schema.json and --help. The Docs workflow builds it on pull requests and publishes it to GitHub Pages from main.
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 and why
Phase 4 of the roadmap: a documentation site at https://tech-byte-frontier.github.io/jevgate/ (mdBook, GitHub Pages).
site/src): install, quick start, what it finds, languages, CI, configuration, output, privacy and cost, how it works (with the evidence-unit document), limits and the changelog, taken from the README's sections; plus new pages on coding agents (checking before finishing, exit codes, JSON,--watchandserve) and troubleshooting (each exit-2 message and what to do, uncertain files, wrong findings, skipped files, colors).site/generate.pyfrom the build: every rule fromjevgate rules --format json, every configuration key, level and rule name fromjevgate.schema.json, and every command's--help. They are not checked in, so they can't go stale.main, publishes it to Pages (enabled with GitHub Actions as the source). mdBook is a pinned release checked against its SHA-256.The README still holds the same text; slimming it to point at the site is a separate change.
How it was checked
site/build.shbuilds with mdBook 0.5.4 without warnings, and every internal link and anchor in the built site resolves.