Repository navigation
Fix two rendering bugs in the Harbor env docs - #1272
Merged
Merged
Conversation
Keep the `openenv harbor <command> --help` code span on one line: when it wrapped, the continuation line started with `<command>`, which the HF doc-builder parsed as HTML and broke the paragraph. Remove a blank line that split the `openenv harbor serve` flags table, which left the `--api-key` and `--auth-header` rows rendered as literal pipes.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Merged
5 of 19 tasks
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
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
Fixes two rendering bugs on the Harbor environment docs page, in both
docs/source/environments/harbor.mdand its sourceenvs/harbor_env/README.md:`openenv harbor <command> --help`wrapped across two lines. The continuation line started with<command>, which the HF doc-builder parses as HTML, so the paragraph broke and the backticks showed up literally. The span now sits on one line.openenv harbor serveflags table: a blank line split the table, so the--api-keyand--auth-headerrows rendered as a paragraph of literal pipes (on GitHub too). Removed the blank line.I checked the whole repo for the first pattern (an inline code span continuing onto a line that starts with
<). These two copies are the only ones.Type of Change
Alignment Checklist
Before submitting, verify:
.claude/docs/PRINCIPLES.mdand this PR aligns with our principles.claude/docs/INVARIANTS.mdand no invariants are violated/pre-submit-pr(orbash .claude/hooks/lint.shand tests) and addressed all issuesMarkdown-only change, no code touched.
RFC Status
Test Plan
Check the doc-builder preview of
environments/harbor: the "CLI reference" intro renders as one paragraph with the command in a code span, and theopenenv harbor servetable includes the--api-keyand--auth-headerrows.Claude Code Review
N/A
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only formatting fixes with no runtime or behavioral changes.
Overview
Fixes markdown rendering on the Harbor environment docs in
docs/source/environments/harbor.mdand the mirroredenvs/harbor_env/README.md.In the CLI reference intro, the inline
`openenv harbor <command> --help`span no longer wraps so a new line starts with<command>(which the Hugging Face doc-builder treated as HTML and broke the paragraph).In the
openenv harbor serveflags table, a blank line between--env-fileand--api-keyis removed so--api-keyand--auth-headerstay part of one table instead of rendering as a broken pipe line.Reviewed by Cursor Bugbot for commit 2e5d4c4. Bugbot is set up for automated code reviews on this repo. Configure here.