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

README nits + diagram #145

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

README nits + diagram #145

wants to merge 4 commits into from

Conversation

BrendanCoughlan5
Copy link

@BrendanCoughlan5 BrendanCoughlan5 commented Dec 9, 2024

readme + diagram makes it easier to understand

@BrendanCoughlan5 BrendanCoughlan5 requested a review from a team as a code owner December 9, 2024 23:16
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -23,6 +23,21 @@ A core responsibility of the Sidecar is facilitating the calculations of [reward
* MacOS
* Linux (Ubuntu/Debian)

# Diagram
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesnt belong in this particular context. Eventually we'll have more detailed docs that show the architecture of the sidecar.

README.md Outdated
```

```bash
# Example for holesky testnet
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is inaccurate since this request is relevant for both holesky and mainnet. Better to just leave it out entirely

Copy link
Member

@seanmcgary seanmcgary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments

@BrendanCoughlan5 BrendanCoughlan5 self-assigned this Dec 11, 2024
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.

2 participants