docs: add onboarding diagrams and entrypoints#4311
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive onboarding guide and architecture diagrams for the CoW Protocol services. The review identified several critical logic and syntax errors in the Mermaid diagrams, specifically the use of non-standard 'smart' quotes that break rendering and incorrect loop boundaries in the sequence diagram that failed to capture the full auction lifecycle. Additionally, the system context diagram was updated to correctly reflect the auction distribution flow to colocated solvers.
9b903ca to
6616a56
Compare
Add docs/ONBOARDING.md with Mermaid architecture/flow diagrams and practical code entrypoints. Link it from the repository README.
6616a56 to
70c2d54
Compare
MartinquaXD
left a comment
There was a problem hiding this comment.
Looks good overall. I imagine this should be helpful for new contributors / colleagues.
|
|
||
| DR -->|simulate + submit tx| CH[("EVM chain\n+ Settlement contract")] | ||
| CO -->|submit tx| CH | ||
| AP -->|index events| CH |
There was a problem hiding this comment.
nit: I'd flip this arrow, since the events originate on-chain and are captured by the autopilot.
There was a problem hiding this comment.
Here and in the other comment, I think the distinction will always be in the eye of the beholder, I understand both ways of thinking
Autopilot actively indexes events by querying the chain
Autopilot actively indexes events from the chain
I'll keep them as is
Description
Addresses review feedback on #4296.
New contributors need a single place to see how orderbook, autopilot, driver, solvers, Postgres, and the chain fit together, plus where to open the codebase for each area. This PR adds
docs/ONBOARDING.mdwith Mermaid diagrams and practical code entrypoints, and links it fromREADME.md.Changes
docs/ONBOARDING.md: system context diagram, order→auction→settle sequence diagram, service responsibilities diagram, DB mental model diagramrun.rsfor each service (orderbook, autopilot, driver, solvers, contracts, database)ETH_RPC_URLnote, cargo check/nextest, formatting)COW_ORDER_DEBUG_SKILL.mdREADME.mdwith a link todocs/ONBOARDING.mdHow to test
docs/ONBOARDING.mdon GitHub and confirm all Mermaid blocks render (context flowchart, sequence diagram, responsibilities flowchart, DB flowchart)playground/README.md,database/README.md, andCOW_ORDER_DEBUG_SKILL.mdand confirm they resolveREADME.mdand confirm the new onboarding link points to./docs/ONBOARDING.md