This repository contains the documentation for the Telestion Project. Go to docs page.
Please note that this does not contain technical references for all Telestion modules. For that, please refer to the individual READMEs and other resources of the individual modules. Instead, this documentation focuses on more general documentation of the Telestion project.
You can find a guide for writers/contributors to the documentation at
src/pages/writers-guide.mdx, or, within the built website, at
/writers-guide.
Please familiarize yourself with these guidelines before beginning to write documentation for the project.
The docs/_templates folder has templates for the most common types of pages
you need to write to document the project.
These also include tips and tricks (as comments) as well as valuable snippets relevant to this specific kind of page (for example, a tutorial)
If you feel like any basic templates are lacking, please search through this repository's issues for a reference to this kind of template. If you don't find any reference to it, please feel free to open an issue for it yourself.