Skip to content

Docs: README post-iter14 bridge ext refresh 0.0.46#84

Merged
kickthemoon0817 merged 2 commits into
mainfrom
docs/readme-modernize-iter24
May 5, 2026
Merged

Docs: README post-iter14 bridge ext refresh 0.0.46#84
kickthemoon0817 merged 2 commits into
mainfrom
docs/readme-modernize-iter24

Conversation

@kickthemoon0817
Copy link
Copy Markdown
Owner

Summary

iter24 fixes the most visible README staleness: the project tree
section still listed a top-level exts/ directory that hasn't
existed since iter14 moved the bridge ext into the wheel. Plus
adds a brief Isaac Sim bridge extension setup subsection
covering the iter14 install-bridge + iter15 bridge-up
workflow with the --symlink recommendation for repo-checkout
users.

Changes

  • README.md project-tree section: replace the stale
    exts/khemoo.simul.mcp/ reference with the canonical
    src/simul_mcp/bridge_ext/khemoo.simul.mcp/ path + a
    one-line pointer at simul-mcp isaac install-bridge.
  • New Isaac Sim bridge extension setup subsection (15 lines)
    with two example commands and a pointer to CLAUDE.md for
    the full lifecycle.
  • 4-file lockstep bumped to 0.0.46.

Pure docs change, no source impact.

How to Test

CI workflow run on this branch is the live verification — both
jobs (unit-tests matrix + packaging-gate) should pass unchanged.

Checklist

Testing

  • No source-code changes, no test changes.
  • CI workflow run is the live verification.

Compatibility

  • Documentation only.

Documentation

  • No remaining exts/ references in README (verified via
    grep -nE "exts/khemoo|exts/" README.md).

Two stale items in the project tree section:

- 'exts/' top-level directory no longer exists since iter14 moved
  the bridge ext into the wheel. Replace with the canonical
  src/simul_mcp/bridge_ext/khemoo.simul.mcp/ path and a one-line
  pointer at the install-bridge command.
- A new 'Isaac Sim bridge extension setup' subsection covers the
  iter14 install-bridge + iter15 bridge-up workflow with the
  --symlink recommendation for repo-checkout users. Brief — the
  full lifecycle stays in CLAUDE.md.

Pure docs change, no source impact.
@kickthemoon0817 kickthemoon0817 merged commit e822d98 into main May 5, 2026
8 checks passed
@kickthemoon0817 kickthemoon0817 deleted the docs/readme-modernize-iter24 branch May 5, 2026 10:57
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.

1 participant