Skip to content

[Doc] Project documentation needs improvement #58

@jokemanfire

Description

@jokemanfire

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

  • Add module 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

Metadata

Metadata

Assignees

Labels

T-enhancementNew features and enhancementshelp wantedExtra attention is needed

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions