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

doc: add MkDocs documentation #94

Merged
merged 1 commit into from
Aug 4, 2023
Merged

Conversation

cjrh
Copy link
Collaborator

@cjrh cjrh commented Jul 21, 2023

Overview

This PR adds a /docs directory with content generated using MkDocs which is becoming something of a standard in the py community. MkDocs is a pleasure to work with, and I hope encourages contributors to improve the documentation.

The goal is to deploy this documentation on https://readthedocs.org/.

I've added a file structure and tree based on the Diátaxis. I am by no means an expert in this framework, but the basic idea of separating different content based on the needs of the reader makes a lot of sense and seems tractable for us to maintain.

It is obviously quite sparse at the moment, but one has to start somewhere. I've copied some of the information in the README into these docs, into where I thought were the appropriate sections. If we're happy with these docs, and we get them deployed to readthedocs, then we can remove some of that duplicated information from the README and just link to the new docs.

Screenshots

Here are some examples of what it looks like:

The home page that will show on first load:

image

Some of the tutorial content from our existing README:

image

@wallies
Copy link
Collaborator

wallies commented Jul 22, 2023

@cjrh amazing docs. What's the flow to deploy these docs?

@cjrh
Copy link
Collaborator Author

cjrh commented Jul 22, 2023

What's the flow to deploy these docs?

The flow is "I ask @wallies to set up something" and then magically some steps show up in CI to deploy to readthedocs 😁

@cjrh
Copy link
Collaborator Author

cjrh commented Aug 4, 2023

@wallies @Sidhant29 Can we move forward on this now, and then set up deploy to readthedocs as a separate work?

@cjrh cjrh merged commit a01ccd9 into quickwit-oss:master Aug 4, 2023
10 checks passed
@cjrh cjrh deleted the add-documentation branch May 3, 2024 20:27
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.

2 participants