Skip to content

docs: improve developer experience — build deps, dev workflow, Zed tasks#710

Merged
rgbkrk merged 1 commit intomainfrom
docs/developer-experience
Mar 11, 2026
Merged

docs: improve developer experience — build deps, dev workflow, Zed tasks#710
rgbkrk merged 1 commit intomainfrom
docs/developer-experience

Conversation

@rgbkrk
Copy link
Member

@rgbkrk rgbkrk commented Mar 11, 2026

Improving developer onboarding for both humans and agents.

build-dependencies.md:

  • Removed stale PR Settings schema unification and file watching #209 reference — states current behavior directly
  • Fixed Python wheel description: crates/runtimed-py/Cargo.toml with bindings = "pyo3" (was wrong: crates/runt/Cargo.toml with bindings = "bin")
  • Added notebook-doc to both Mermaid dependency graphs — it's the shared Automerge doc layer that runtimed, runtimed-wasm, and runtimed-py all depend on
  • Fixed phantom sidecar→runt-cli edge (no such dependency)
  • Added missing edges: runt-cli→runt-workspace, runtimed→notebook-doc, runtimed-wasm→notebook-doc

development.md:

  • Fixed AGENTS.md → CLAUDE.md reference
  • Added explicit env var instructions for agents using raw terminal (not Zed tasks): RUNTIMED_DEV=1 and RUNTIMED_WORKSPACE_PATH
  • Added "Before You Commit" section — formatting was only documented in CLAUDE.md, first-time contributors would get CI failures
  • Added "Zed Editor Integration" section documenting the .zed/tasks.json tasks and how they set dev env vars via $ZED_WORKTREE_ROOT

README.md:

  • Added notebook-doc to project structure tree
  • Added Contributing section linking to the key guides

PR submitted by @rgbkrk's agent Quill, via Zed

build-dependencies.md:
- Remove stale PR #209 reference
- Fix Python wheel description (pyo3, not bin bindings)
- Add notebook-doc to both dependency graphs
- Fix sidecar→runt-cli edge (doesn't exist)
- Add runt-workspace and kernel deps to crate graph

development.md:
- Fix AGENTS.md → CLAUDE.md reference
- Add explicit env var instructions for agents in raw terminals
- Add 'Before You Commit' section with formatting requirements
- Add 'Zed Editor Integration' section documenting .zed/tasks.json

README.md:
- Add notebook-doc to project structure tree
- Add Contributing section with links to key guides
@rgbkrk rgbkrk merged commit 9b10659 into main Mar 11, 2026
6 checks passed
@rgbkrk rgbkrk deleted the docs/developer-experience branch March 11, 2026 19:29
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