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

Documentation #3

Open
10 tasks
Sable-20 opened this issue Mar 28, 2024 · 0 comments
Open
10 tasks

Documentation #3

Sable-20 opened this issue Mar 28, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Sable-20
Copy link
Owner

Document:

  • Public structs
  • Public enums
  • Public functions
  • Private structs
  • Private enums
  • Private functions

Misc Todo:

  • Setup manpage generation via clap_man and cargo_xtasks
  • Write cargo doc style documentation for everything so that documentation pages can automatically be generated
  • Create contribution instructions
  • Create coding conventions file including any settings for clippy or rustfmt that aren't programmatically added
@Sable-20 Sable-20 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 28, 2024
Sable-20 added a commit that referenced this issue Apr 11, 2024
Realized I was trying to fix the devShell which was already working when it was the build command failing
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 good first issue Good for newcomers
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant