Merge pull request #15 from Frix-x/img-link
improved documentation UX with images links Also added a long banner to avoid cluttering space when it's not needed (in the documentation)
This commit is contained in:
@@ -11,11 +11,11 @@ It operates in two steps:
|
||||
2. Relocates the graphs and associated CSV files to your Klipper config folder for easy access via Mainsail/Fluidd to eliminate the need for SSH.
|
||||
3. Manages the folder by retaining only the most recent results (default setting of keeping the latest three sets).
|
||||
|
||||
The [detailed documentation is here](./docs/README.md).
|
||||
Check out the **[detailed documentation of the Shake&Tune module here](./docs/README.md)**. You can also look at the documentation for each type of graph by directly clicking on them below to better understand your results and tune your machine!
|
||||
|
||||
| Belts graphs | Axis graphs | Vibrations measurement |
|
||||
| [Belts graph](./docs/macros/belts_tuning.md) | [Axis input shaper graphs](./docs/macros/axis_tuning.md) | [Vibrations graph](./docs/macros/vibrations_tuning.md) |
|
||||
|:----------------:|:------------:|:---------------------:|
|
||||
|  |  |  |
|
||||
| [<img src="./docs/images/belts_example.png">](./docs/macros/belts_tuning.md) | [<img src="./docs/images/axis_example.png">](./docs/macros/axis_tuning.md) | [<img src="./docs/images/vibrations_example.png">](./docs/macros/vibrations_tuning.md) |
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@@ -1,13 +1,16 @@
|
||||
# Klippain Shake&Tune module documentation
|
||||
|
||||

|
||||
|
||||
### Detailed documentation
|
||||
|
||||
1. [Input Shaping and tuning generalities](./is_tuning_generalities.md)
|
||||
1. [Belt graphs](./macros/belts_tuning.md)
|
||||
1. [Axis Input Shaper graphs](./macros/axis_tuning.md)
|
||||
1. [Klippain vibrations graphs](./macros/vibrations_tuning.md)
|
||||
First, check out **[input shaping and tuning generalities](./is_tuning_generalities.md)** to understand how it all works and what to look for when taking these measurements.
|
||||
Then look at the documentation for each type of graph by clicking on them below to better understand your results and tune your machine!
|
||||
|
||||
| [Belts graph](./macros/belts_tuning.md) | [Axis input shaper graphs](./macros/axis_tuning.md) | [Vibrations graph](./macros/vibrations_tuning.md) |
|
||||
|:----------------:|:------------:|:---------------------:|
|
||||
| [<img src="./images/belts_example.png">](./macros/belts_tuning.md) | [<img src="./images/axis_example.png">](./macros/axis_tuning.md) | [<img src="./images/vibrations_example.png">](./macros/vibrations_tuning.md) |
|
||||
|
||||

|
||||
|
||||
### Complementary ressources
|
||||
|
||||
|
||||
BIN
docs/banner_long.png
Normal file
BIN
docs/banner_long.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 740 KiB |
Reference in New Issue
Block a user