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 overhaul for v1 #534

Open
8 of 15 tasks
mantzas opened this issue Aug 13, 2022 · 0 comments
Open
8 of 15 tasks

Documentation overhaul for v1 #534

mantzas opened this issue Aug 13, 2022 · 0 comments
Labels
enhancement New feature or request maintenance Maintenance work

Comments

@mantzas
Copy link

mantzas commented Aug 13, 2022

Is your feature request related to a problem? Please describe

Before we release v1 we need to overhaul our documentation.
This should be done when all issues for this milestone has been resolved.
We need to brainstorm on what is good documentation.
Should we rely on Go's documentation to provide details.
Should the readme have everything and we are ok with duplication?

Packages to cover:

@mantzas mantzas added this to the v1.0.0 Release milestone Aug 13, 2022
@mantzas mantzas added enhancement New feature or request maintenance Maintenance work labels Aug 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance Maintenance work
Projects
None yet
Development

No branches or pull requests

1 participant