-
Notifications
You must be signed in to change notification settings - Fork 98
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
Initial documentation import. #440
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jankatins
reviewed
Jul 30, 2021
jankatins
reviewed
Jul 30, 2021
rdunklau
force-pushed
the
docs_improvements
branch
2 times, most recently
from
August 2, 2021 14:12
4e2f4ed
to
57a5815
Compare
kmichel-aiven
previously requested changes
Aug 16, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few tiny errors but great job adding all this documentation 👍
This adds a documentation using sphinx, which is basically the content of the README file, with some editing and a bit more content in some places. I left a lot of FIXME in the documentation since there is still much to do, but at least it will be a nice start.
rdunklau
force-pushed
the
docs_improvements
branch
from
August 16, 2021 15:34
57a5815
to
ab10f15
Compare
rdunklau
dismissed
kmichel-aiven’s stale review
August 16, 2021 15:34
Typos fixed and FIXMEs removed
kmichel-aiven
approved these changes
Aug 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a documentation using sphinx, which is basically the content
of the README file, with some editing and a bit more content in some
places.
I left a lot of FIXME in the documentation since there is still much to
do, but at least it will be a nice start.
References #435