Skip to content

[Doc] Project documentation needs improvement #58

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

Open
4 tasks
jokemanfire opened this issue Mar 29, 2025 · 2 comments
Open
4 tasks

[Doc] Project documentation needs improvement #58

jokemanfire opened this issue Mar 29, 2025 · 2 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@jokemanfire
Copy link
Collaborator

jokemanfire commented Mar 29, 2025

The doc of the project is currently very incomplete, and we need to improve it

  • Add module level document annotations
  • Add item level document annotations
  • The documentation generated by cargo doc needs to serve as guidance
  • Each crate should have its own dedicated readme, with the top-level readme responsible for indexing
@jokemanfire jokemanfire added enhancement New feature or request help wanted Extra attention is needed labels Mar 29, 2025
@jokemanfire jokemanfire added this to the Pre release milestones milestone Apr 6, 2025
@EItanya
Copy link
Contributor

EItanya commented Apr 7, 2025

I'll have some time on the plane today, I can have a go at working on this, feel free to assign me.

@jokemanfire
Copy link
Collaborator Author

Very thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants