Skip to content

Call the product OpenBolt in the generated reference docs - #353

Merged
bastelfreak merged 2 commits into
OpenVoxProject:mainfrom
miharp:fix-352-openbolt-name
Oct 29, 2026
Merged

bastelfreak merged 2 commits into
OpenVoxProject:mainfrom
miharp:fix-352-openbolt-name

Conversation

@miharp

@miharp miharp commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Fixes #352.

The reference pages that rake docs:all generates 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 what bolt --help prints, so the CLI help changes with it, continuing 643ce3a.
  • lib/bolt/config/options.rb and lib/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 in rakelib/pwsh.rake.
  • The YARD docstrings in bolt-modules/ that become the plan functions and data types pages.

Naming rule

From the openvox-docs CONTRIBUTING:

  • OpenBolt for the product, with "a" changed to "an" where the name follows it.
  • Bolt stays in names spelled that way: the bolt command, bolt-project.yaml, the PuppetBolt module and its cmdlets, Bolt:: classes.
  • Plans, tasks, modules, and plugins are generic nouns, so "Bolt plans" becomes "plans", not "OpenBolt plans".
  • Link text matches the title of the page it points to, for example "Configuring OpenBolt" and "Connecting OpenBolt to OpenVoxDB".

A few related fixes in the same lines:

  • "Find Bolt's documentation at https://bolt.guide" now points to https://docs.openvoxproject.org/openbolt/latest/.
  • "the Bolt PowerShell module" is now "the PuppetBolt PowerShell module", the module's actual name.
  • "A Bolt Future object" is now "A Future object", after the data type's name.
  • The run-as-command description had a typo, "must not require aninteractive password prompt" (separate commit).

Left as is

  • The sudo prompt quoted in privilege_escalation.md, which is the literal string in lib/bolt/shell/bash.rb.
  • Seven module summaries on the packaged modules page, which come from the Forge API.
  • Warnings and errors elsewhere in lib/bolt, which can follow separately as the issue suggests.
  • Internal code comments such as "Bolt executor not expected…", which aren't rendered.

Verification

  • Across the nine generated pages, the only "Bolt" left in prose is the seven Forge summaries. No "a OpenBolt".
  • Built the openvox-docs site locally with these pages, using its own import step. All 20 same-site links on them resolve.
  • rake schemas:all reproduces the committed schemas.
  • rubocop is 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-By trailer.

Assisted by Claude.

miharp and others added 2 commits October 28, 2026 10:39
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
bastelfreak merged commit 3f1d93a into OpenVoxProject:main Oct 29, 2026
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generated reference pages still call the product Bolt

2 participants