Skip to content

docs: mark non-executable code blocks as skip - #2043

Closed
leshy wants to merge 3 commits into
mainfrom
lesh/fix/doc-codeblocks-skip
Closed

leshy wants to merge 3 commits into
mainfrom
lesh/fix/doc-codeblocks-skip

Conversation

@leshy

@leshy leshy commented May 11, 2026 •

Copy link
Copy Markdown
Member

Summary

Three docs were failing the doc-codeblocks CI job because they contain illustrative code blocks that can't be executed in CI:

Net diff: 10 lines, each just appends skip to a fence opener.

Fixes doc-codeblocks CI: nav_stack.md, g1/index.md, and
visualization.md contain illustrative blocks that can't run
in CI (placeholder syntax, missing imports across subprocess
boundaries, hardware/network dependencies, gRPC server startup).

Per docs/agents/docs/codeblocks.md, mark each with `skip`.
@greptile-apps

greptile-apps Bot commented May 11, 2026 •

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes CI failures in the doc-codeblocks job by appending skip to code fence openers for illustrative examples that cannot be executed in CI (e.g., hardware-dependent shell commands and configuration snippets that require a live robot environment).

  • Six Python code blocks in nav_stack.md and visualization.md are marked skip, preventing the CI runner from attempting to execute partial configuration snippets.
  • Two shell blocks in g1/index.md are marked skip to avoid executing device-specific SSH and curl | sh commands during CI.
  • A stray blank line is removed from navigation/readme.md (cosmetic only).

Confidence Score: 5/5

Documentation-only change that adds skip markers to code fences; no logic, runtime behavior, or executable code is modified.

Every change in this PR is a one-token addition to a Markdown code fence opener. The underlying code examples are left entirely intact; only the CI runner's handling of them changes. There is nothing here that could introduce a runtime regression or a behavioral change.

No files require special attention.

Important Files Changed

Filename Overview
docs/capabilities/navigation/nav_stack.md Six illustrative Python code blocks marked skip to prevent CI execution; no content changes.
docs/capabilities/navigation/readme.md Cosmetic-only change: removes a blank line after the heading.
docs/platforms/humanoid/g1/index.md Two shell code blocks (SSH + curl install commands) marked skip to avoid CI execution against hardware.
docs/usage/visualization.md Two Python code blocks marked skip; no content changes to the examples themselves.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[doc-codeblocks CI job] --> B{Code block has 'skip'?}
    B -->|Yes| C[Skip execution]
    B -->|No| D[Attempt to execute block]
    D --> E{Executable in CI?}
    E -->|Yes| F[Pass]
    E -->|No - hardware/env deps| G[CI FAIL]
    C --> H[Pass]

    style G fill:#f55,color:#fff
    style F fill:#5c5,color:#fff
    style H fill:#5c5,color:#fff
Loading

Reviews (3): Last reviewed commit: "random touch of readme" | Re-trigger Greptile

@leshy
leshy enabled auto-merge (squash) May 11, 2026 04:58
@spomichter
spomichter disabled auto-merge May 11, 2026 07:53
spomichter
spomichter previously approved these changes May 11, 2026
@leshy
leshy enabled auto-merge (squash) May 11, 2026 12:54
@leshy leshy closed this May 12, 2026
auto-merge was automatically disabled May 12, 2026 10:05

Pull request was closed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants