Skip to content

fix(man): strip leading commas from BNF grammar blocks in generated MDX#28

Open
Kaysahni wants to merge 1 commit into
mainfrom
kanishk/fix-leading-comma-in-grammar-blocks
Open

fix(man): strip leading commas from BNF grammar blocks in generated MDX#28
Kaysahni wants to merge 1 commit into
mainfrom
kanishk/fix-leading-comma-in-grammar-blocks

Conversation

@Kaysahni

@Kaysahni Kaysahni commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • BNF grammar blocks in the man page sources use comma-first style (, field = value) — a roff/man page convention for list continuation
  • This rendered as broken syntax in Mintlify (the leading commas appeared verbatim)
  • Adds a sed pass in sync-man-pages.sh to replace ^, with (two spaces), preserving alignment
  • Regenerates manifest.toml.mdx and flox-containerize.mdx with the fix applied

Fixes the formatting issue reported by James in the Package descriptors section.

Test plan

  • Verify manifest.toml page renders grammar blocks without leading commas
  • Verify flox-containerize page renders ContainerizeConfig block cleanly
  • Confirm alignment is preserved in code blocks

🤖 Generated with Claude Code

The man page sources use comma-first style for grammar continuations
(a roff convention). This is fine in terminal man pages but renders as
broken syntax in Mintlify. Add a sed pass in the sync script to replace
leading ', ' with '  ' (preserving alignment), and regenerate affected
pages.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 5, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
flox 🟢 Ready View Preview Jun 5, 2026, 10:23 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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