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

Initial documentation import. #440

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Initial documentation import. #440

merged 1 commit into from
Aug 16, 2021

Conversation

rdunklau
Copy link
Contributor

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

@jankatins jankatins requested a review from a team July 30, 2021 14:46
docs/about.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@rdunklau rdunklau force-pushed the docs_improvements branch 2 times, most recently from 4e2f4ed to 57a5815 Compare August 2, 2021 14:12
Copy link
Contributor

@kmichel-aiven kmichel-aiven left a 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 👍

docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/commands.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
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 rdunklau dismissed kmichel-aiven’s stale review August 16, 2021 15:34

Typos fixed and FIXMEs removed

@kmichel-aiven kmichel-aiven merged commit 243aead into master Aug 16, 2021
@kmichel-aiven kmichel-aiven deleted the docs_improvements branch August 16, 2021 21:14
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

Successfully merging this pull request may close these issues.

3 participants