Contributing

This section is for people changing Sim2Bot itself. It covers the repository, the boundary between browser and bridge, verification, and how user-facing API documentation is generated.

Local workflow

npm install
npm run dev:web

Before handing off a change, run the checks appropriate to its scope:

npm run verify
npm run bridge:test

Documentation-only changes should also pass a strict MkDocs build. See Contributing to documentation.

Where to continue

• Architecture — browser, simulation, bridge, SDK, and docs boundaries.
• Documentation — local preview and generated API pages.
• Documentation versions — when and how to introduce stable/versioned docs.

The source repository remains private during the preview. Maintainers with repository access should use its README.md, AGENTS.md, PUBLISHING.md and TODO.md as the current engineering and release references.

Branch workflow

Develop and test locally, publish testable changes to staging only when requested, then merge confirmed work into main for production. Documentation is published by its separate Cloudflare Pages project as described in the repository's PUBLISHING.md.