9c550a8f9a
Moonraker's external API documentation has been significantly overhauled in an effort to improve clarity and readability. All parameters and responses are documented with specifications. Tables and other elements are used to make documentation more visible and less verbose. Spelling and other corrections have also been added. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
23 lines
959 B
Markdown
23 lines
959 B
Markdown
# Welcome to Moonraker Documentation
|
|
|
|
Moonraker is a Python 3 based web server that exposes APIs with which
|
|
client applications may use to interact with the 3D printing firmware
|
|
[Klipper](https://github.com/Klipper3d/klipper). Communication between
|
|
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
|
|
is used to provide Moonraker's server functionality.
|
|
|
|
Users should refer to the [Installation](installation.md) and
|
|
[Configuration](configuration.md) sections for documentation on how
|
|
to install and configure Moonraker.
|
|
|
|
Front end and other client developers may refer to the
|
|
[External API](./external_api/introduction.md)
|
|
documentation.
|
|
|
|
Backend developers should refer to the
|
|
[contributing](contributing.md) section for basic contribution
|
|
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.
|