Repository navigation
Call the product OpenBolt in the generated reference docs - #353
Merged
Merged
Conversation
The reference pages that `rake docs:all` builds, and the `bolt --help` text they share with the command and cmdlet references, still called the product Bolt. openvox-docs publishes those pages next to hand-written pages that say OpenBolt. Follow the openvox-docs naming rule: say OpenBolt for the product and keep Bolt only in names spelled that way (the `bolt` command, `bolt-project.yaml`, the PuppetBolt module, `Bolt::` classes). Plans, tasks, modules, and plugins are generic nouns, so "Bolt plans" becomes "plans". Link text now matches the titles of the pages it points to. Leave the sudo prompt in privilege_escalation.md as is, since it quotes the literal string from lib/bolt/shell/bash.rb, and leave the Forge module summaries on the packaged modules page, which come from the Forge API. Regenerate the JSON schemas, which carry the option descriptions. Fixes OpenVoxProject#352 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
The description read "must not require aninteractive password prompt". It shows on the transports reference page, next to text this branch already changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
bastelfreak
approved these changes
Oct 29, 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
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.
Fixes #352.
The reference pages that
rake docs:allgenerates still called the product Bolt, about 240 times outside code on the 5.6.0 pages. openvox-docs publishes them next to hand-written pages that say OpenBolt. This changes the text at its sources:lib/bolt/bolt_option_parser.rb: help text for the command and cmdlet references. This is also whatbolt --helpprints, so the CLI help changes with it, continuing 643ce3a.lib/bolt/config/options.rbandlib/bolt/config/transport/options.rb: option descriptions for the project, defaults, and transports references. The JSON schemas are regenerated from them.documentation/templates/*.md.erb, plus two help strings inrakelib/pwsh.rake.bolt-modules/that become the plan functions and data types pages.Naming rule
From the openvox-docs CONTRIBUTING:
boltcommand,bolt-project.yaml, the PuppetBolt module and its cmdlets,Bolt::classes.A few related fixes in the same lines:
run-as-commanddescription had a typo, "must not require aninteractive password prompt" (separate commit).Left as is
privilege_escalation.md, which is the literal string inlib/bolt/shell/bash.rb.lib/bolt, which can follow separately as the issue suggests.Verification
rake schemas:allreproduces the committed schemas.rubocopis clean, and the option parser, CLI, and config specs pass.AI usage disclosure
Per the Vox Pupuli and OpenVox AI Usage Policy: I used Claude Code to find the sources, make the change, run the verification above, and draft this description. The commits carry a
Co-Authored-Bytrailer.Assisted by Claude.