Skip to content

Ivan/fix/doc codeblocks skip2 - #2052

Merged
spomichter merged 4 commits into
mainfrom
ivan/fix/doc-codeblocks-skip2
May 12, 2026
Merged

spomichter merged 4 commits into
mainfrom
ivan/fix/doc-codeblocks-skip2

Conversation

@leshy

@leshy leshy commented May 12, 2026 •

Copy link
Copy Markdown
Member

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

greptile-apps Bot commented May 12, 2026 •

Copy link
Copy Markdown
Contributor

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

codecov Bot commented May 12, 2026

Copy link
Copy Markdown

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!

@spomichter
spomichter merged commit 31e4c35 into main May 12, 2026
11 checks passed
@spomichter
spomichter deleted the ivan/fix/doc-codeblocks-skip2 branch May 12, 2026 18:47
mustafab0 pushed a commit that referenced this pull request May 13, 2026
jiangtao129 added a commit to jiangtao129/dimos that referenced this pull request May 14, 2026
* perf(rerun): render voxel maps as Points3D spheres instead of Boxes3D (dimensionalOS#1793)

* feat(api): add porcelain api with connect (dimensionalOS#1779)

* fix(rerun): dimos-viewer version upgrade (dimensionalOS#1785)

* Task: Add meaningful manipulation tests (dimensionalOS#1765)

* feat: never leave child processes alive after the parent (dimensionalOS#1886)

* Fix mac UDP (dimensionalOS#1789)

* Remove sim from base install (dimensionalOS#1878)

* fix(tests): fix flakey porcelain test (dimensionalOS#1900)

* feat(go2): rage mode via webrtc (dimensionalOS#1903)

* feat:rust native modules (dimensionalOS#1794)

Co-authored-by: leshy <lesh@sysphere.org>

* Feat/memory2 - plotting, examples, recorder module, semantic search (dimensionalOS#1769)

Co-authored-by: RD <63036454+ruthwikdasyam@users.noreply.github.com>

* fix attributes (dimensionalOS#1918)

* Jeff/fix/rconnect2 (dimensionalOS#1784)

* fix(types): resolve mypy 3.10 errors (dimensionalOS#1921)

* feat(go2):  go2 SDK adapter + nix cyclonedds setup (dimensionalOS#1885)

Co-authored-by: Mustafa Bhadsorawala <39084056+mustafab0@users.noreply.github.com>

* Revert "Jeff/fix/rconnect2" (dimensionalOS#1924)

* feat(modules): async modules (dimensionalOS#1920)

* chore(logging): enforce usage of setup_logger (dimensionalOS#1895)

* feat(api): peek_stream (dimensionalOS#1909)

* CI/macos: skip failing tests (dimensionalOS#1944)

* fix(ci): restrict code-cleanup workflow to Linux runners only (dimensionalOS#1948)

* Fix/memory2 go2 autorecorder (dimensionalOS#1925)

* Convert patrol module to be an async module (dimensionalOS#1939)

* feat(tool-streams): add tool streams (dimensionalOS#1713)

* G1 Low level connection module coordinator integration (dimensionalOS#1954)

* feat(sim): MuJoCo sim teleop for xarm + piper (dimensionalOS#1958)

* Show child process cpu usage in dtop (dimensionalOS#1880)

Co-authored-by: leshy <lesh@sysphere.org>

* Task: OpenArm Integration with DimOS (dimensionalOS#1897)

Co-authored-by: Paul Nechifor <paul@nechifor.net>
Co-authored-by: RD <63036454+ruthwikdasyam@users.noreply.github.com>
Co-authored-by: Andrew Lauer <69774903+aclauer@users.noreply.github.com>
Co-authored-by: leshy <lesh@sysphere.org>
Co-authored-by: Jeff Hykin <jeff.hykin@gmail.com>

* md-babel-py bump (dimensionalOS#1994)

* new hong kong office recording (dimensionalOS#1991)

* chore(security): update packages with issues (dimensionalOS#1989)

* Make whisper an optional extra with faster-whisper by default (dimensionalOS#1877)

* Drop perception. Update docs. (dimensionalOS#1888)

* Add codecov (dimensionalOS#1889)

* go2 lidar timestamps bugfix (dimensionalOS#1992)

* go2 cli (dimensionalOS#1990)

* refactor(core): memory2 for dtop (dimensionalOS#2004)

* fix: adaptive timestamp correction (dimensionalOS#2021)

Co-authored-by: Ivan Nikolic <lesh@sysphere.org>

* Disable codecov status check (dimensionalOS#2026)

* fixes replay mem leak (dimensionalOS#2025)

* fix: launch arm blueprints with --simulation flag (dimensionalOS#2027)

* small fixes for release (dimensionalOS#2019)

* chore: add problems back

* Change Codecov branch from 'dev' to 'main'

* docs: remove mentions of dev

* Ivan/fix/go2recording2 (dimensionalOS#2034)

* mapper memory leak fix, measurement transforms (dimensionalOS#2031)

* Feat/1759 doc codeblocks ci (dimensionalOS#1884)

* Nav Stack 0.1

* fix(security): upgrade some packages (dimensionalOS#2040)

* go2 apriltag recordings (dimensionalOS#2044)

* Ivan/fix/doc codeblocks added skip2 (dimensionalOS#2052)

* feat Aruco/Apriltag generator (dimensionalOS#2037)

* Split tests off of self hosted runner (dimensionalOS#1901)

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

* fix(verify): exclude unitree-dds extra to avoid cyclonedds C lib

Upstream introduced `dimos[unitree-dds]` which depends on
`cyclonedds==0.10.5`. The Python binding tries to compile against the
CycloneDDS C library, which is not installed on the fork's
ubuntu-latest runner. This makes verify fail with:
  Could not locate cyclonedds. Try to set CYCLONEDDS_HOME or CMAKE_PREFIX_PATH

Upstream's own `ci.yml` (line 36) already passes
`--no-extra dds --no-extra unitree-dds`; align the fork's verify with it.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: RD <63036454+ruthwikdasyam@users.noreply.github.com>
Co-authored-by: Paul Nechifor <paul@nechifor.net>
Co-authored-by: Mustafa Bhadsorawala <39084056+mustafab0@users.noreply.github.com>
Co-authored-by: Sam Bull <git@sambull.org>
Co-authored-by: Andrew Lauer <69774903+aclauer@users.noreply.github.com>
Co-authored-by: leshy <lesh@sysphere.org>
Co-authored-by: Jeff Hykin <jeff.hykin@gmail.com>
Co-authored-by: stash <pomichterstash@gmail.com>
Co-authored-by: Dan Vi <bogwi@tutamail.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: jiangtao-huazhijian <jiang.tao@topsunpower.cc>
Co-authored-by: Cursor <cursoragent@cursor.com>
jeff-hykin pushed a commit that referenced this pull request Oct 18, 2026
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