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

Improve cargo docs #71

Open
pete-eiger opened this issue Feb 5, 2023 · 0 comments
Open

Improve cargo docs #71

pete-eiger opened this issue Feb 5, 2023 · 0 comments
Labels
meta:good-first-issue Good for newcomers meta:triaged This issue has been triaged (has a good description, as well as labels for priority, size and type) p3 Low priority size:small Small type:documentation Improvements or additions to documentation

Comments

@pete-eiger
Copy link
Contributor

Improve docs that are automatically generated by cargo doc. This includes:

  1. Add more information and examples (real code snippets that can compile from the docs themselves)
  2. Improve structure
  3. Add link to Docs portal and emphasise that it's our central "source of truth"
@hopeyen hopeyen added type:documentation Improvements or additions to documentation size:small Small p3 Low priority and removed meta:awaiting-triage labels Sep 18, 2023
@pete-eiger pete-eiger added the meta:triaged This issue has been triaged (has a good description, as well as labels for priority, size and type) label Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
meta:good-first-issue Good for newcomers meta:triaged This issue has been triaged (has a good description, as well as labels for priority, size and type) p3 Low priority size:small Small type:documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pete-eiger @hopeyen