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

Enhancements for Documentation #35

Open
8 tasks
tareknaser opened this issue Apr 21, 2024 · 0 comments
Open
8 tasks

Enhancements for Documentation #35

tareknaser opened this issue Apr 21, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@tareknaser
Copy link
Collaborator

  • Crate-level documentation for each crate, with verbose explanations for crates that are meant to be published on crates.io.
  • Ensure important structs like ResourceIndex have clear doc comments with API examples.
  • Create CONTRIBUTING.md with guidelines:
    • Code Style Guidelines covering formatting, linting, and disallowing unused crate dependencies.
    • Document each crate, function, struct, and field consistently.
    • Consider test coverage and signing commits?
  • Host high level documentation, possibly with mdbook.
  • Clearly document ark-cli usage.
  • Add ARK logo to the README.
  • Display badges in the README for build status, code coverage, license, etc.,
  • Add structured issue and pull request templates.
@tareknaser tareknaser added the enhancement New feature or request label Apr 21, 2024
@tareknaser tareknaser self-assigned this Apr 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant