Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: autopilot / driver documentation #41

Closed
8 tasks done
mfw78 opened this issue Nov 28, 2023 · 1 comment
Closed
8 tasks done

feat: autopilot / driver documentation #41

mfw78 opened this issue Nov 28, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 team:backend Issues / PRs scoped to backend

Comments

@mfw78
Copy link
Contributor

mfw78 commented Nov 28, 2023

Problem

I'm frustrated at the lack of information around the architecture for the autopilot / driver system and how various components fit together.

Suggested solution

Document the co-location architecture for autopilot / driver / solver.

Alternatives considered

None. We need this 😅

Additional context

The draft templates (not populated) can be found at https://github.com/cowprotocol/docs-v2/tree/main/docs/cow-protocol/tutorials/arbitrate. Feel free to add in any other documents as needed.

Acceptance criteria

  • Populate high level @sunce86
    • Architectural mermaid diagram showing relationship of components
    • Descriptions / overviews of autopilot, driver, solver functionality
    • Sequence diagram of the live of an order (from intent to settlement) - auction abstracted away
    • Sequence diagram of a single auction

Using the template suggested by mfw below:

Review @squadgazzz @narcis96

@mfw78 mfw78 added the documentation Improvements or additions to documentation label Nov 28, 2023
@mfw78
Copy link
Contributor Author

mfw78 commented Nov 29, 2023

Example for structure of each page:

  1. Overview
  2. Architecture
  3. Methodology (how the component works)
  4. Dependencies / interactions

mfw78 added a commit that referenced this issue Dec 3, 2023
# Description

Part of #41 

# Changes

- Explanation of solver engine components with focus on baseline and
naive solver engine
- High level information about the component with drill down on how it
is embedded in the high level architecture

---------

Co-authored-by: mfw78 <[email protected]>
Co-authored-by: Federico Giacon <[email protected]>
Co-authored-by: Martin Beckmann <[email protected]>
@mfw78 mfw78 added E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 team:backend Issues / PRs scoped to backend labels Dec 4, 2023
@fedgiac fedgiac mentioned this issue Dec 5, 2023
mfw78 added a commit that referenced this issue Dec 7, 2023
# Description

Documents how the autopilot works.

# Changes

- Filled in autopilot page.
- Simplified architecture page (separate `/reveal` and `/settle` is too
much information there imho).

## Related Issues

Part of #41.

---------

Co-authored-by: mfw78 <[email protected]>
MartinquaXD added a commit that referenced this issue Dec 13, 2023
# Changes
Adds an overview over the driver.

Part of #41
@mfw78 mfw78 closed this as completed Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation E:2.1: Documentation and Tutorials https://github.com/cowprotocol/pm/issues/10 team:backend Issues / PRs scoped to backend
Projects
None yet
Development

No branches or pull requests

4 participants