3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
moonraker/docs/index.md

16 lines
577 B
Markdown
Raw Normal View History

docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
# Welcome to Moonraker Documentation
Users should refer to the [Installation](installation.md) and
[Configuration](configuration.md) sections for documentation on how
to install and configure Moonraker.
Client developers may refer to the [Client API](web_api.md)
documentation.
docs: remove references to plugins and create components.md Replace various notes with admonitions. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-19 00:16:36 +03:00
Backend developers should refer to the
docs: prepare documentation for readthedocs This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs". Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 13:34:17 +03:00
[contibuting](contributing.md) section for basic contribution
docs: remove references to plugins and create components.md Replace various notes with admonitions. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-19 00:16:36 +03:00
guidelines prior to creating a pull request. The
[components](components.md) document provides a brief overview
of how to create a component and interact with Moonraker's
primary internal APIs.