@@ -8,7 +8,7 @@ Renders the Quarto site and deploys `_site/` to GitHub Pages on every push to
88## ` generate-reference.yml `
99
1010Populates ** versioned** reference docs for the ** whole ecosystem** , driven
11- entirely from this repo — no package repository needs its own workflow. Layout:
11+ entirely from this repo, no package repository needs its own workflow. Layout:
1212
1313```
1414reference/<package>/<version>/<namespace>/<name>.qmd
@@ -20,7 +20,7 @@ On manual dispatch (or a weekly schedule) it:
2020 (` openpipeline ` , ` openpipeline_spatial ` , ` openpipeline_qc ` ,
2121 ` openpipeline_composed ` ; ` openpipeline_rapids ` excluded for now),
22222 . ** caches** : if ` reference/<package>/<version>/ ` already exists, that version
23- is skipped and never rebuilt — so a run does nothing unless a ** new** release
23+ is skipped and never rebuilt, so a run does nothing unless a ** new** release
2424 has appeared ("latest forward"),
25253 . for each new version, clones that tag from viash-hub (public, no credentials;
2626 the tag ships the built ` target/ ` the generator reads) and runs
@@ -34,12 +34,12 @@ organized by package + version and can never drift from released code. The
3434generator must read a ** built** package (` target/ ` ), which is why we pull tagged
3535releases from viash-hub rather than ` main ` (where ` target/ ` is not committed).
3636
37- ** Setup required:** add repo secret ** ` GTHB_PAT ` ** — used only as the
37+ ** Setup required:** add repo secret ** ` GTHB_PAT ` ** : used only as the
3838` viash_pro_token ` , which the generator needs to clone the private
3939` viash-io/viash_tools ` repo. Package fetching itself needs no credentials. This
4040is the same token the production website workflow uses; reuse that value. Then
4141run the workflow from the Actions tab (** Generate reference → Run workflow** ) to
4242produce the first PR.
4343
44- Never hand-edit anything under ` reference/<package>/<version>/ ` — a version is
44+ Never hand-edit anything under ` reference/<package>/<version>/ ` , a version is
4545generated once and then frozen (later runs skip it).
0 commit comments