From be2e8623b9d7f40481e6be94338a540f330b86a8 Mon Sep 17 00:00:00 2001 From: Brian 'Redbeard' Harrington Date: Tue, 29 Mar 2022 10:00:27 -0700 Subject: [PATCH] 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 --- README.md | 2 +- docs/index.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 52de788..263af61 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Moonraker - API Web Server for Klipper Moonraker is a Python 3 based web server that exposes APIs with which -client applications may use to interact with +client applications may use to interact with the 3D printing firmware [Klipper](https://github.com/KevinOConnor/klipper). Communcation between the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado is used to provide Moonraker's server functionality. diff --git a/docs/index.md b/docs/index.md index 0f93305..77de29b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,11 @@ # 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/KevinOConnor/klipper). Communcation 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.