Skip to content

Fix two rendering bugs in the Harbor env docs - #1272

Merged
cursor[bot] merged 1 commit into
mainfrom
docs-fix-harbor-render
Sep 29, 2026
Merged

cursor[bot] merged 1 commit into
mainfrom
docs-fix-harbor-render

Conversation

@sergiopaniego

@sergiopaniego sergiopaniego commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Fixes two rendering bugs on the Harbor environment docs page, in both docs/source/environments/harbor.md and its source envs/harbor_env/README.md:

  • CLI reference intro: the inline code span `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 serve flags table: a blank line split the table, so the --api-key and --auth-header rows 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

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • New environment
  • Refactoring

Alignment Checklist

Before submitting, verify:

  • I have read .claude/docs/PRINCIPLES.md and this PR aligns with our principles
  • I have checked .claude/docs/INVARIANTS.md and no invariants are violated
  • I have run /pre-submit-pr (or bash .claude/hooks/lint.sh and tests) and addressed all issues

Markdown-only change, no code touched.

RFC Status

  • Not required (bug fix, docs, minor refactoring)
  • RFC exists: #___
  • RFC needed (will create before merge)

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 the openenv harbor serve table includes the --api-key and --auth-header rows.

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.md and the mirrored envs/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 serve flags table, a blank line between --env-file and --api-key is removed so --api-key and --auth-header stay 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.

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.
@burtenshaw burtenshaw added documentation Improvements or additions to documentation size: small Small pull request labels Sep 29, 2026 — with Cursor
@bot-ci-comment

Copy link
Copy Markdown

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.

@cursor
cursor Bot merged commit 4f4c85f into main Sep 29, 2026
15 checks passed
@cursor cursor Bot mentioned this pull request Sep 30, 2026
5 of 19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size: small Small pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants