aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Overview.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: add info about requesting bootloadersAaron B. Haun2023-10-121-0/+1
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* axis_twist_compensation: Add X twist compensation module (#6149)Philippe Daouadi2023-08-011-0/+2
| | | | | | | | | | | | Implements AxisTwistCompensation, and Calibrater Supports calibration of z-offsets caused by x gantry twist Modify PrinterProbe._probe function to check if the probed z value should be adjusted based on axis_twist_compensation's configuration Add documentation for [axis_twist_compensation] module Signed-off-by: Jeremy Tan <jeremytkw98@gmail.com>
* docs: Add new CANBUS_Troubleshooting.md documentKevin O'Connor2023-05-301-0/+2
| | | | | | Add information on troubleshooting canbus connections. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typos (#6032)Thijs Triemstra2023-02-201-1/+1
| | | Signed-off-by: Thijs Triemstra <info@collab.nl>
* docs: add exclude_object documentationFrank Tackitt2022-06-031-0/+2
| | | | | | | Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <git@frank.af> Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
* docs: Rename DocumentsYifei Ding2021-11-221-3/+3
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* mcu: Support multi-mcu homingKevin O'Connor2021-08-281-2/+3
| | | | | | | Support endstops and probes attached to a different micro-controller than their associated steppers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Don't use section-index plugin during klipper3d.org site generationKevin O'Connor2021-08-171-1/+1
| | | | | | | The section-index plugin can cause some confusing navigation. Use the simpler site navigation for now. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-4/+6
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Move status field reference to new Status_Reference.md fileKevin O'Connor2021-04-281-0/+2
| | | | | | | Move the reference of "printer" status fields from Command_Templates.md to a new Status_Reference.md file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* output_pin: Support setting max_duration (#3995)Pascal P2021-03-261-0/+2
| | | | | Also added documentation for using powered tools. Signed-off-by: Pascal Pieper <accounts@pascalpieper.de>
* docs: Move Example_Configs.md reference in Overview.mdKevin O'Connor2021-03-221-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Example_Configs.md - info on adding new config files to KlipperKevin O'Connor2021-03-221-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update CAN bus documentsKevin O'Connor2021-03-131-2/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* canbus: Rework CAN command protocolKevin O'Connor2021-03-131-0/+2
| | | | | | | Rework the micro-controller command protocol so that it supports direct communication with the serialqueue.c code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename Sensorless_homing.md to TMC_Drivers.md and extendKevin O'Connor2021-03-101-2/+2
| | | | | | Add additional information on configuring and using TMC drivers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add SDCard_Updates.md to Overview.mdKevin O'Connor2021-02-101-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a link in Overview.md to Bed_Mesh.mdKevin O'Connor2021-01-241-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Rotation_Distance.md documentKevin O'Connor2020-12-181-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move config reference information to new Config_Reference.mdKevin O'Connor2020-11-181-2/+2
| | | | | | | Move all the config reference information from files in the config/ directory to a new Config_Reference.md document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial API_Server.md documentKevin O'Connor2020-10-171-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Measuring_Resonances.md to Overview.mdKevin O'Connor2020-10-161-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move and reword the Resonance_Compensation.md link in Overview.mdKevin O'Connor2020-08-051-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add RPi_microcontroller.md link in Overview.mdKevin O'Connor2020-08-011-2/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Suggested improvements to Input Shaper tuning guideDmitry Butyugin2020-07-291-0/+2
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* hall_filament_width_sensor: Add new filament sensortest3210-d2020-02-141-0/+1
| | | | Signed-off-by: Denis Ignatenko <deniss979@gmail.com>
* docs: Remove outdated stm32f1.md documentKevin O'Connor2019-10-231-2/+0
| | | | | | | The stm32f103 has become popular in the "skr mini" series of boards. As a result, the stm32f1.md document is no longer relevant. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add skew_correction.md to Overview.mdKevin O'Connor2019-06-271-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an initial Command_Templates.md documentKevin O'Connor2019-06-041-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rewrite the Overview.md - just list documents by categoryKevin O'Connor2019-04-161-47/+60
| | | | | | | | Replace the Overview.md document description with a list of documents and a brief description of their contents. The goal is to make it easier for users to find information. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using .. in markdown linksKevin O'Connor2019-04-141-4/+6
| | | | | | | Using .. in the markdown link can confuse some document processors. Use an absolute link to github instead. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move benchmark information from Debugging.md to new Benchmarks.mdKevin O'Connor2019-03-281-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Manual_Probe.md documentKevin O'Connor2019-02-241-9/+6
| | | | | | | Add information on calibrating the bed on traditional printers with a Z endstop and bed screws. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Bed_Level.md and Probe_Calibrate.md documentsKevin O'Connor2019-02-121-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a new Config_Changes.md documentKevin O'Connor2019-01-071-2/+5
| | | | | | | Add a document to track non-backwards compatible changes to the printer config file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Slicers.md documentKevin O'Connor2018-10-281-1/+2
| | | | | | Add some information on configuring a slicer for use with Klipper. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an Endstop_Phase.md documentKevin O'Connor2018-10-161-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Delta_Calibrate.md guide with "enhanced delta calibration"Kevin O'Connor2018-09-251-1/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add stm32f1.md link to Overview.mdKevin O'Connor2018-09-201-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Bootloaders.md documentKevin O'Connor2018-08-081-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Remove the Todo.md fileKevin O'Connor2018-07-261-2/+0
| | | | | | | The Todo.md file has gotten stale, and it is no longer an effective mechanism for tracking changes. Remove it. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a G-Codes.md file with the list of available commandsKevin O'Connor2018-03-081-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an initial configuration checklist documentKevin O'Connor2017-12-261-2/+5
| | | | | | | Provide a document with basic steps that a user can run to verify that the pins in the configuration file are set correctly. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ documentKevin O'Connor2017-11-301-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Contact.md file with developer contact informationKevin O'Connor2017-10-101-1/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve documentation for those starting in docs/Kevin O'Connor2017-04-271-14/+26
| | | | | | | | Those that reach Klipper via github may jump directly to the docs/ directory in search of documentation. Add README.md and rework Overview.md with that in mind. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using "firmware" in the documentationKevin O'Connor2017-04-271-3/+3
| | | | | | | | The term "firmware" is ambiguous - it could refer to the entire project (host and micro-controller software) or to just the micro-controller software. Avoid the term in the documentation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial Pressure Advance tuning documentKevin O'Connor2017-04-191-4/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add initial Kinematics documentKevin O'Connor2017-04-151-2/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Releases page with history of releasesKevin O'Connor2016-12-231-8/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 09:24:12 +0000