Skip to content

fix: correct code fence language guidance in CONTRIBUTING.md#244

Merged
tuxmea merged 1 commit into
OpenVoxProject:masterfrom
miharp:fix/contributing-formatting-guidance
May 23, 2026
Merged

fix: correct code fence language guidance in CONTRIBUTING.md#244
tuxmea merged 1 commit into
OpenVoxProject:masterfrom
miharp:fix/contributing-formatting-guidance

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented May 23, 2026

Summary

  • Fixes the Formatting section of CONTRIBUTING.md
  • command is not a valid Rouge lexer — Jekyll silently falls back to no highlighting; replace with console, which Rouge supports
  • Update the example in the same bullet from bash to console
  • Clarify when bash and puppet are appropriate (scripts and manifests) vs console (interactive terminal commands)

Test plan

  • Confirmed console fences render with language-console class and prompt highlighting in a local jekyll build

Replace the invalid 'command' Rouge lexer with 'console', which is
what Jekyll/Rouge actually supports. Update the example in the same
bullet to use 'console' instead of 'bash', and clarify when to use
'bash' or 'puppet' vs 'console'.

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp requested a review from a team as a code owner May 23, 2026 11:25
@tuxmea tuxmea merged commit b533026 into OpenVoxProject:master May 23, 2026
4 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.

2 participants