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

Create documentation #21

Open
Tracked by #10
doodspav opened this issue Oct 22, 2023 · 0 comments
Open
Tracked by #10

Create documentation #21

doodspav opened this issue Oct 22, 2023 · 0 comments
Assignees

Comments

@doodspav
Copy link
Owner

doodspav commented Oct 22, 2023

At minmum:

  • for users:
    • introduction (uses cases and such)
    • core design decisions and goals
    • version guarantees
    • how to build/install
    • changelog
    • documentation for all APIs (as well as their guarantees)
    • examples on how to use them
    • API reference list (should this be separate?)
    • FAQ
  • for contributors:
    • rules (like code style, branch convention, etc...)
    • architecture diagram
    • example of how to support a new architecture or implementation
  • other
    • test results?
    • code coverage?

Also:

  • basic readme
  • badges showing coverage and pipeline info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant