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

docs: Document the repo structure and sub-crates on the main README.md #798

Open
aborgna-q opened this issue Mar 7, 2025 · 0 comments
Open

docs: Document the repo structure and sub-crates on the main README.md #798

aborgna-q opened this issue Mar 7, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@aborgna-q
Copy link
Collaborator

For each crate README, ensure that they have

  • A short description of the package
  • Links to docs.rs or python docs
  • For binary crates: usage explanation, potentially copied from cargo run -- --help
    • Those may need some cleaning up on the clap definition.
@aborgna-q aborgna-q added the documentation Improvements or additions to documentation label Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aborgna-q