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

chore(docs): Binary Documentation #22

Open
Tracked by #34
refcell opened this issue Oct 3, 2023 · 0 comments
Open
Tracked by #34

chore(docs): Binary Documentation #22

refcell opened this issue Oct 3, 2023 · 0 comments
Labels
A-bin Area: Binary related alpha C-chore Category: Chore M-good-first-issue Meta: Good first issue

Comments

@refcell
Copy link
Collaborator

refcell commented Oct 3, 2023

Description

Following the precedent set in reth, minimal binary documentation should be done inline with extensive markdown book docs to avoid duplicate, and out-of-sync documentation.

For this issue, the opup binary readme.md file should be removed and minimal inline docs should be added to opup/src/lib.rs.

In the future, more extensive documentation will be added to documents in the docs/ mdbook.

@refcell refcell added A-bin Area: Binary related C-chore Category: Chore alpha M-good-first-issue Meta: Good first issue labels Oct 3, 2023
@refcell refcell mentioned this issue Oct 4, 2023
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-bin Area: Binary related alpha C-chore Category: Chore M-good-first-issue Meta: Good first issue
Projects
None yet
Development

No branches or pull requests

1 participant