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.

Sign up for GitHub

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

Jump to bottom

[CHECKLIST] Improve Documentation #596

Open
10 tasks
1xstj opened this issue May 5, 2023 · 1 comment
Open
10 tasks

[CHECKLIST] Improve Documentation #596

1xstj opened this issue May 5, 2023 · 1 comment
Assignees
@1xstj
Labels
p3 🔵 Issues should be resolved eventually

Comments

@1xstj
Copy link
Contributor

1xstj commented May 5, 2023

Overview

The goal is to improve the state of documentation and README in general

Checklist

For every crate/pallet we should

  • Add a README with an overview on what the crate/pallet does and how to use/test it
  • Improve rust docs where possible

Crates

  • Dkg-metadata
  • dkg-proposals
  • dkg-proposal-handler
  • dkg-gadget
  • dkg-orchestrator
  • dkg-logging
  • dkg-mock-blockchain
  • dkg-test-suite
@1xstj 1xstj added the p3 🔵 Issues should be resolved eventually label May 5, 2023
@drewstone
Copy link
Contributor

Possible useful tool: https://docs.rs/cargo-readme/latest/cargo_readme/

@1xstj 1xstj self-assigned this May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@1xstj 1xstj

Labels
p3 🔵 Issues should be resolved eventually
Projects
Webb Universe
Status: EPICS 🚀
Milestone
No milestone
Development

No branches or pull requests
2 participants
@drewstone @1xstj