Skip to content

Add initial design documents#1

Draft
lsy3 wants to merge 2 commits intoros-tooling:mainfrom
lsy3:docs/initial-design-proposal
Draft

Add initial design documents#1
lsy3 wants to merge 2 commits intoros-tooling:mainfrom
lsy3:docs/initial-design-proposal

Conversation

@lsy3
Copy link

@lsy3 lsy3 commented Feb 22, 2026

Summary

Founding design documents for the rosgraph project:

  • docs/MANIFESTO.md — project direction: why, what, how (short)
  • docs/ROSGRAPH.md — full technical proposal: schema, architecture, phasing, prior art, 51 features across 7 subcommands
  • docs/FAQ.md — audience-organized FAQ covering 9 perspectives (new ROS dev, AI-assisted dev, eng lead, safety engineer, nav2/MoveIt user, skeptic, package maintainer, educator, embedded dev)

Context

These documents are the starting point for WG discussion. The PR serves as the review and acceptance process — please comment inline.

Key sections in ROSGRAPH.md

  • §1 Executive Summary — the problem, the tool, quick start
  • §3 Architecture — graph model, schema layers, subcommands
  • §4 Phasing — what ships when
  • §5 Language Choice — Rust vs Python vs hybrid (open decision)
  • §9 Existing Ecosystem — maturity matrix and gap analysis

@lsy3 lsy3 force-pushed the docs/initial-design-proposal branch from 84ecd9e to df9de93 Compare February 22, 2026 18:37
Three founding documents for the rosgraph project:
- MANIFESTO.md: project direction (why, what, how)
- ROSGRAPH.md: full technical proposal (schema, architecture, phasing)
- FAQ.md: audience-organized FAQ covering 9 perspectives

Signed-off-by: Luke Sy <sylukewicent@gmail.com>
@lsy3 lsy3 force-pushed the docs/initial-design-proposal branch from df9de93 to 0450557 Compare February 22, 2026 18:48
- FAQ: reduce from 880 to ~360 lines, add General section with
  cross-cutting questions, keep 2-3 essential per audience
- FAQ: fix all PROPOSAL.md cross-references to ROSGRAPH.md
- FAQ: add launch file / param config convergence question
- ROSGRAPH §3.2: add "Toward a single source of truth" note on
  system.yaml replacing launch files and parameter configs
- ROSGRAPH §12: remove resolved questions section (internal notes)

Signed-off-by: Luke Sy <sylukewicent@gmail.com>
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