Skip to content

chore: auto-update cli docs from upstream#597

Closed
cploujoux wants to merge 1 commit into
mainfrom
auto-update-docs-cli
Closed

chore: auto-update cli docs from upstream#597
cploujoux wants to merge 1 commit into
mainfrom
auto-update-docs-cli

Conversation

@cploujoux

@cploujoux cploujoux commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Automated update of CLI docs

@mendral-app

mendral-app Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🔍 PR Change Analysis

This PR is a trivial docs-only change — it removes two markdown code fence (```) delimiters from cli-reference/commands/bl_drive.md, which changes how the drive command usage text is rendered (from a code block to plain text).

No component interactions or architectural flows are affected, so a sequence diagram is not applicable here.

Note

Posted by PR Sequence Diagram · Tag @mendral-app with feedback.

mendral-app[bot]

This comment was marked as outdated.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

Open in Devin Review

Comment on lines 20 to 22
bl drive mount --sandbox <s> ... Mount a drive to a running sandbox
bl drive unmount --sandbox <s> ... Unmount a drive from a running sandbox
bl drive mounts --sandbox <s> List drives mounted in a running sandbox

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Removing code fences causes <name> and <s> to be parsed as HTML tags, breaking rendered output

The code fences (```) surrounding the Synopsis content were removed, but the content contains angle-bracket placeholders like <name> (line 15) and `` (lines 20-22). Without code fences, Markdown parsers will interpret these as HTML tags. In particular, `` is a valid HTML strikethrough tag, so everything following the first `` on line 20 will be rendered with strikethrough formatting. `` is a non-standard HTML tag that most renderers will silently consume, making the placeholder invisible. Additionally, the whitespace-based column alignment between command and description will collapse since Markdown doesn't preserve multiple spaces outside code blocks.

(Refers to lines 13-22)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin seems to be correct, the deployment is failing. Also this should be corrected upstream, since docs receives and parses these generated pages from upstream. Could we fix the source command help text @cploujoux ?

@vikram-blaxel vikram-blaxel Jun 8, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Investigating further, noting this is related to an AI-generated PR that was auto-merged #596. Should we revert that?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

@cploujoux cploujoux force-pushed the auto-update-docs-cli branch from b42706e to 1e163bd Compare June 9, 2026 06:22
@mendral-app

mendral-app Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

🧪 Testing Guide

What this PR addresses

Removes stray markdown code fence markers (```) around the command listing in the bl drive CLI reference page. These backticks were incorrectly wrapping the command descriptions as a code block, which likely caused rendering issues in the documentation site (the command list would appear as a raw code block instead of formatted text).

Steps to reproduce the original issue

  1. Navigate to the docs site and open the bl drive CLI reference page (or preview the file cli-reference/commands/bl_drive.md in a markdown renderer).
  2. Observe that the "Drive CRUD" and "Sandbox mount operations" sections were rendered inside a code block due to the surrounding ``` markers.

What to verify (expected behavior)

  1. After this PR, preview cli-reference/commands/bl_drive.md in a markdown renderer or the docs site.
  2. Confirm the command listing under "Manage drives and drive mounts on sandboxes" renders as regular text (not inside a code block).
  3. Verify no other formatting is broken on the page — the "Examples" section and other content should still render correctly.

This is an automated docs update with a minor formatting fix. No functional CLI behavior changes — only documentation rendering is affected.

Note

Posted by PR Testing Guide · Tag @mendral-app with feedback.

@vikram-blaxel

vikram-blaxel commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Noting here that this is still broken even after the fix commit. Preview page returns an error due to the code fencing issue in upstream generated doc.

Preview https://blaxel-auto-update-docs-cli.mintlify.app/cli-reference/commands/bl_drive

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