Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
name: Docs
# Builds the documentation site (site/build.sh) and publishes it to GitHub
# Pages from main. Pull requests that touch what the site is made from only
# build it, so a broken page or include fails before it merges.
# Pages when a release tag is pushed, so the site describes the released
# binary. Pull requests that touch what the site is made from only build it,
# so a broken page or include fails before it merges; a manual run publishes
# the ref it runs on.
on:
push:
branches: [main]
tags: ["v*"]
pull_request:
paths: ["site/**", "README.md", "CHANGELOG.md", "docs/classification-cascade.md", "jevgate.schema.json", ".github/workflows/docs.yml"]
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ JevGate asks the model small questions and decides findings in code. When you ch

## Documentation site

The site at <https://tech-byte-frontier.github.io/jevgate/> is built from `site/` with [mdBook](https://rust-lang.github.io/mdBook/): `site/build.sh` generates the rules, configuration and command-line reference pages from a release build, then builds the book into `site/book`. Guide pages are in `site/src`; the reference pages are generated, so change the rule catalog, the configuration types or the `--help` text instead.
The site at <https://tech-byte-frontier.github.io/jevgate/> is built from `site/` with [mdBook](https://rust-lang.github.io/mdBook/): `site/build.sh` generates the rules, configuration and command-line reference pages from a release build, then builds the book into `site/book`. It is published with each release, so it describes the released binary. Guide pages are in `site/src`; the reference pages are generated, so change the rule catalog, the configuration types or the `--help` text instead.

## Pull requests

Expand Down
Loading