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

22 lines
917 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
docs: Remove ambiguity from documentation index Presently the index page of the documentation makes no attempt to clarify what Moonraker is or even that it has anything to do with 3D printing or CNC machine control. This attempts to add a basic clarification by using the top level description from README.md. Additionally this adds a second clarification that Klipper is a "3D printer firmware" (as referenced in the Klipper `README.md`) in this projects `README.md`. Signed-off-by: Brian 'Redbeard' Harrington <redbeard@dead-city.org>
2022-03-29 20:00:27 +03:00
Moonraker is a Python 3 based web server that exposes APIs with which
client applications may use to interact with the 3D printing firmware
docs: fixes minor typos Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2023-02-23 17:06:41 +03:00
[Klipper](https://github.com/Klipper3d/klipper). Communication between
docs: Remove ambiguity from documentation index Presently the index page of the documentation makes no attempt to clarify what Moonraker is or even that it has anything to do with 3D printing or CNC machine control. This attempts to add a basic clarification by using the top level description from README.md. Additionally this adds a second clarification that Klipper is a "3D printer firmware" (as referenced in the Klipper `README.md`) in this projects `README.md`. Signed-off-by: Brian 'Redbeard' Harrington <redbeard@dead-city.org>
2022-03-29 20:00:27 +03:00
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
is used to provide Moonraker's server functionality.
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
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: fixes minor typos Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2023-02-23 17:06:41 +03:00
[contributing](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.