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

Rewrite Collection Documentation and Tutorial #336

Open
9 tasks
maxhoesel opened this issue Oct 10, 2023 · 0 comments
Open
9 tasks

Rewrite Collection Documentation and Tutorial #336

maxhoesel opened this issue Oct 10, 2023 · 0 comments
Labels
docs Documentation improvements
Milestone

Comments

@maxhoesel
Copy link
Collaborator

maxhoesel commented Oct 10, 2023

As part of the 1.x release, this collections docs could use an overhaul.

Right now, pretty much all of the general documentation is in the README.md, which makes the file long and difficult to read.
At the same time, many details aren't elaborated on and the step-by-step guide has not been updated in a while.

To bring the docs up to a standard deserving of a 1.x release, the following changes should be made:

@maxhoesel maxhoesel added the docs Documentation improvements label Oct 10, 2023
@maxhoesel maxhoesel added this to the version-1 milestone Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant