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.

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

Enhance documentation #43

Open
3 tasks
daniel-mader opened this issue Jun 30, 2023 · 0 comments
Open
3 tasks

Enhance documentation #43

daniel-mader opened this issue Jun 30, 2023 · 0 comments
Assignees
Labels
Documentation Improvements or additions to documentation

Comments

@daniel-mader
Copy link

Description

The documentation of the individual crates should be easy to understand for first-time users. Simple diagrams on how the individual crates are related should be included.

Motivation

Improve developer experience

Resources

No response

To-do List

  • add README.md to each crate in the monorepo
  • generate and publish docs to a website (docs.impierce.com?)
  • add diagrams
@daniel-mader daniel-mader added the Documentation Improvements or additions to documentation label Jun 30, 2023
@nanderstabel nanderstabel self-assigned this Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

2 participants