docs: fix flag cheatsheet table layout - #726
Open
alexeagle wants to merge 6 commits into
Open
Conversation
Keep the curated flag cheatsheet editable in bazel-docs so Mintlify-specific improvements do not require upstream Bazel changes. Exclude only this page from the upstream MDX sync; all other documentation remains on the existing pipeline.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Keep the kind example table at full width in Mintlify and preserve the local fix across upstream syncs.
Keep query/language.mdx on the upstream sync path and reapply the local table-width fix as a checked-in unified patch.
Keep the Mintlify ResponseField layout without repeating a non-informative type chip for every flag.
Give the code example column half the table width so the kind example remains readable in the Mintlify preview.
Replace the unsupported HTML table with a Mintlify Columns layout containing a Starlark listing and target-kind explanation.
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
1 participant
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.
Summary
ResponseFieldentries while preserving flag anchors and links.query/language.mdxon the normal upstream sync path and apply a checked-in unified patch that replaces the problematickindexample table with MintlifyColumns, containing a Starlark code listing and target-kind explanation.reference/flag-cheatsheet.mdxfrom the upstream MDX rsync.Rationale
The flag cheatsheet is curated editorial content rather than generated reference data. Keeping its source in bazel-docs enables Mintlify-native presentation and faster content iteration without requiring changes in Bazel's upstream sources. Bazel continues to own and generate the authoritative command-line and query reference material.
The versioned flag-cheatsheet copies also show that upstream co-location has provided little maintenance value: across the release snapshots, only the 9.0.0 copy contains substantive editorial changes (
--test_filter, the sandbox recommendation, and the displayed--show_timestampsspelling). The other version-to-version differences are formatting changes or heading-anchor repairs.The query language page remains synchronized with upstream; its layout adjustment is represented as a checked-in patch. If upstream changes the surrounding content, the patch will fail visibly and require review.
Closes #374