Skip to content

Ivan/fix/doc codeblocks skip2#2052

Open
leshy wants to merge 4 commits into
mainfrom
ivan/fix/doc-codeblocks-skip2
Open

Ivan/fix/doc codeblocks skip2#2052
leshy wants to merge 4 commits into
mainfrom
ivan/fix/doc-codeblocks-skip2

Conversation

@leshy
Copy link
Copy Markdown
Contributor

@leshy leshy commented May 12, 2026

CI broken on prev PR #2043

leshy added 3 commits May 11, 2026 09:49
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
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 12, 2026

Greptile Summary

This PR fixes CI failures introduced by the previous PR (#2043) by adding the skip flag to documentation code blocks that can't execute in CI — blocks that reference hardware modules, placeholder imports, or would mutate the CI environment.

  • nav_stack.md: Six python code blocks marked skip; these reference user-defined robot modules (from my_robot.control import MyRobotControl) or use ellipsis placeholders that would fail at runtime.
  • g1/index.md: Two sh code blocks marked skip; one runs robot-on-board software and the other executes curl ... | sh to install tooling, both unsuitable for CI.
  • visualization.md: Two python code blocks marked skip; they reference global_config.viewer which is undefined in block scope and a ModuleCoordinator loop that would block the runner.
  • voxels.py: RST-style double-backtick inline-code markers removed from a Python comment; cosmetic change only.

Confidence Score: 5/5

Safe to merge — adds skip flags to documentation code blocks that cannot run in CI and makes a cosmetic comment tweak in a Python file.

All changes are targeted and mechanical: blocks that reference hardware, placeholder module imports, undefined variables, or environment-mutating shell commands are correctly flagged skip. No application logic is touched and no previously-passing blocks are being suppressed.

No files require special attention.

Important Files Changed

Filename Overview
docs/capabilities/navigation/nav_stack.md Six Python code blocks correctly marked skip; they contain placeholder imports or undefined variables that cannot execute in CI.
docs/platforms/humanoid/g1/index.md Two shell code blocks marked skip; one runs robot-onboard software requiring hardware, the other invokes `curl
docs/usage/visualization.md Two Python code blocks marked skip; one references global_config.viewer (undefined in block scope), the other calls .loop() which would block the CI runner indefinitely.
dimos/mapping/voxels.py Cosmetic cleanup: RST double-backtick inline-code markers removed from a Python comment; no logic change.
docs/capabilities/navigation/readme.md Trivial whitespace removal (blank line after heading); no functional change.

Sequence Diagram

sequenceDiagram
    participant PR as Pull Request
    participant GH as GitHub Actions
    participant BIN as bin/run-doc-codeblocks
    participant MB as md-babel-py

    PR->>GH: Push / synchronize
    GH->>BIN: /entrypoint.sh bash -c "./bin/run-doc-codeblocks --ci --no-cache"
    BIN->>MB: md-babel-py run --lang python,sh,node ./docs --recursive
    loop "Each code block in docs/**"
        MB->>MB: Check fence flags
        alt "flag == skip"
            MB-->>MB: Skip block (no execution)
        else no flag
            MB->>MB: Execute block
            alt Execution succeeds
                MB-->>BIN: OK
            else Execution fails
                MB-->>GH: CI FAILURE
            end
        end
    end
    BIN-->>GH: All blocks passed
    GH-->>PR: doc-codeblocks check green
Loading

Reviews (2): Last reviewed commit: "checking if code change is required" | Re-trigger Greptile

@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

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.

1 participant