Here are some concepts you should know before adding the doc toolchain to a project.
We recommend using reStructuredText markup language to write documentation. Additionally, the toolchain supports Markdown.
The tool we use to convert restructuredText and Markdown to HTML. Sphinx comes with directives and extensions, which add additional options for formatting the text.
All ScyllaDB documentation projects share a theme to have a common look and feel. In addition, ScyllaDB Sphinx Theme preinstalls a set of custom functionalities to make them available for all projects.
We use the third-party extension sphinx-multiversion to build docs for different versions.
Hosts the code and docs source files of ScyllaDB projects.
Hosts the HTML version of the docs generated by Sphinx.
Builds and deploys the documentation to GitHub Pages whenever new content is in the GitHub repository default branch.
Builds a preview site for the docs every time someone sends a pull request that updates the docs folder.
Crawls all the documentation sites to offer a unified search experience.