Fix broken cross-links in generated reference pages#251
Merged
Sharpie merged 1 commit intoJun 3, 2026
Merged
Conversation
The generated reference pages emit internal cross-links whose anchors do not match the rendered heading IDs (or point at the wrong page), so they 404 when published. Fixed at the source that feeds the generators: - plan_functions#run-plan -> #run_plan (bolt_types_reference template) - apply_prep self-link #apply-prep -> #apply_prep (apply func desc in rakelib/docs.rake) - bolt_inventory_reference#plugin-hooks-1 -> #plugin_hooks-1 (Target type) - writing_plans#collect-facts-from-targets -> #collect-facts-from-the-targets (Target type and facts function) - writing_plugins#hooks -> #plugin-hooks (plugin-hooks option) - using_plugins#task -> supported_plugins#task (plugin-hooks option; the task plugin is documented on supported_plugins) The bolt-defaults/bolt-project schema JSON are regenerated from the same OPTIONS hash, so they are updated to match. Verified with html-proofer against a full openbolt docs build: the generated-page cross-links above resolve. The authored pages these link into (writing_plans, writing_tasks) live downstream in openvox-docs; a companion render-bug fix there is OpenVoxProject/openvox-docs#289. Fixes OpenVoxProject#249 Signed-off-by: Michael Harp <mike@mikeharp.com>
miharp
force-pushed
the
fix-249-generated-reference-crosslinks
branch
from
f0065ac to
6a31dce
Compare
Sharpie
approved these changes
Jun 3, 2026
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.
What
Fixes the broken internal cross-links emitted by the generated reference pages (#249). These 404 when published to docs.openvoxproject.org/openbolt/latest and can't be fixed downstream because the pages are generated from this repo. All fixed at the source that feeds the generators:
plan_functions#run-plan#run_plandocumentation/templates/bolt_types_reference.md.erb[apply_prep](#apply-prep)(self-link)#apply_preprakelib/docs.rake(applyfunc desc)bolt_inventory_reference#plugin-hooks-1#plugin_hooks-1bolt-modules/.../datatypes/target.rbwriting_plans#collect-facts-from-targets#collect-facts-from-the-targetstarget.rb+bolt-modules/.../functions/facts.rbwriting_plugins#hooks#plugin-hookslib/bolt/config/options.rbusing_plugins#tasksupported_plugins#tasklib/bolt/config/options.rbThe
bolt-defaults/bolt-projectschema JSON are regenerated from the same OPTIONS hash, so they're updated to match. (Thetaskplugin is documented onsupported_plugins, notusing_plugins.)On the "removed/relocated sections" in the issue
While verifying, the failures into
writing_plans/writing_tasksturned out not to be removed sections — those sections still exist. The published pages stopped emitting heading IDs partway down because kramdown flipped into raw mode (a<TYPE> <PARAMETER_NAME>code span split across a line break, and```shell scriptfences with a space in the info string). Those authored pages now live only in openvox-docs, so that render-bug fix is the companion PR OpenVoxProject/openvox-docs#289 — not this repo.Verification
Regenerated the openbolt references with these changes into a full openvox-docs build and ran html-proofer scoped to
_site/openbolt/latest; the generated-page cross-links above all resolve (collection reaches 0 broken links together with openvox-docs#289).Fixes #249