Skip to content

docs: Special-case command line reference conversion - #29439

Open
armandomontanez wants to merge 1 commit into
bazelbuild:masterfrom
armandomontanez:better-command-line-reference
Open

docs: Special-case command line reference conversion#29439
armandomontanez wants to merge 1 commit into
bazelbuild:masterfrom
armandomontanez:better-command-line-reference

Conversation

@armandomontanez

Copy link
Copy Markdown
Contributor

Special-cases the command line reference conversion so the generated MDX is formatted in a usable way. Since the HTML is rather rigid and predictable, this is sufficient for the initial migration away from DevSite.

Eventually, the command line reference should be generated externally from e.g. proto so the generation mechanism is not tied to the bazel version.

RELNOTES: None

@github-actions github-actions Bot added team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. awaiting-review PR is awaiting review from an assigned reviewer labels Apr 30, 2026
@armandomontanez

Copy link
Copy Markdown
Contributor Author

@fweikert @alan707 this is blunt and complex, but it produces MUCH better CLI reference docs. The script itself is Slop™, but I'm short on free time this week.

@meteorcloudy
meteorcloudy requested a review from fweikert May 13, 2026 14:26
@meteorcloudy meteorcloudy added P2 We'll consider working on this in future. (Assignee optional) team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website team-Documentation Documentation improvements that cannot be directly linked to other team labels and removed team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. labels May 13, 2026
@armandomontanez
armandomontanez force-pushed the better-command-line-reference branch from 5cc56f7 to f876ac5 Compare May 29, 2026 17:23
Special-cases the command line reference conversion so the generated MDX
is formatted in a usable way. Since the HTML is rather rigid and
predictable, this is sufficient for the initial migration away from
DevSite.

Eventually, the command line reference should be generated externally from
e.g. proto so the generation mechanism is not tied to the bazel version.
@armandomontanez
armandomontanez force-pushed the better-command-line-reference branch from f876ac5 to c031e7b Compare June 15, 2026 22:41
@armandomontanez

Copy link
Copy Markdown
Contributor Author

Ping, the command line reference is pretty broken without this.

@fweikert

Copy link
Copy Markdown
Member

Update: I've imported this change, and it's currently running through presubmit checks.

I had to fix some smaller lint issues, and I removed the changes to src/main/java/com/google/devtools/build/lib/bazel/repository/RepositoryOptions.java since it will make cherry-picking a bit tricky. Can you please send a separate PR for this file?

@ted-xie

ted-xie commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

@armandomontanez I understand the rationale for this PR. What I don't understand is why there appears to be a custom HTML parser in the CLR converter. Could you use lxml instead, or some other off-the-shelf parser?

@bazel-docs-pr-commenter

Copy link
Copy Markdown

✅ Bazel docs preview is ready!

Preview URL: https://bazel-pr-29439.mintlify.app/

Updated for c031e7b4322345f098fe8fc380eae61664d56d52

@armandomontanez

Copy link
Copy Markdown
Contributor Author

I had to fix some smaller lint issues, and I removed the changes to src/main/java/com/google/devtools/build/lib/bazel/repository/RepositoryOptions.java since it will make cherry-picking a bit tricky. Can you please send a separate PR for this file?

Sent out #30701

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-review PR is awaiting review from an assigned reviewer P2 We'll consider working on this in future. (Assignee optional) team-Documentation Documentation improvements that cannot be directly linked to other team labels team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants