aboutsummaryrefslogtreecommitdiffstats
path: root/docs/FAQ.md
Commit message (Collapse)AuthorAgeFilesLines
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-26/+25
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Update FAQ on which mcus have hard pwm supportKevin O'Connor2021-03-261-2/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* config: Create new sample-aliases.cfg with standard aliasesKevin O'Connor2021-03-251-32/+13
| | | | | | | Create a sample-aliases.cfg with all the aliases that are currently hardcoded in the klippy.pins.py module. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Rotation_Distance.md documentKevin O'Connor2020-12-181-19/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Calculate step_distance from rotation_distanceKevin O'Connor2020-12-181-3/+3
| | | | | | | | Add support for automatically calculating the internal step_distance from new config parameters - rotation_distance, microsteps, full_steps_per_rotation, and gear_ratio. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use relative links for files outside the docs/ directoryKevin O'Connor2020-12-031-14/+15
| | | | | | | | Use javascript to fixup the "github pages" rendering of links to files outside the docs/ directory. Then use normal relative links in the documentation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move config reference information to new Config_Reference.mdKevin O'Connor2020-11-181-13/+10
| | | | | | | 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: Expand on host computer restrictions in the FAQKevin O'Connor2020-08-261-0/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add uninstall notes to faqElton Law2020-08-031-0/+11
| | | | | | | | From comments in https://github.com/KevinOConnor/klipper/issues/1084 This documents the script added in 0ba1f5109d639ce92b7efe3ab88057e15694f4c4 Signed-off-by: Elton Law <eltonlaw296@gmail.com>
* docs: Add a "hardware pin type" section to the FAQKevin O'Connor2020-07-161-4/+40
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a "why does klipper report errors" section to FAQKevin O'Connor2020-06-051-1/+32
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update FAQ with TMC2208 "standalone" mode workaroundKevin O'Connor2020-03-291-40/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor FAQ updatesKevin O'Connor2020-01-061-43/+32
| | | | | | | | | | Fix rendering of Patreon URL in FAQ. Use same "ls" command to find the serial port that Installation.md uses. Note Raspberry Pi 4 is supported. Note problems with ModemManager. Point to Bed_Level.md in Z position_endstop question. Link to Config_checks.md in "Z screaching" FAQ. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update FAQ to emphasize checking Config_Changes.md on an upgradeKevin O'Connor2019-12-101-8/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move upgrade instructions to the last item in the FAQKevin O'Connor2019-12-101-20/+20
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend safe_z_home over homing_overrideKevin O'Connor2019-11-071-3/+4
| | | | | | | | Update BLTouch.md, FAQ.md, and sample-probe-as-z-endstop.cfg to recommend using a safe_z_home config section over a homing_override config section. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update FAQ to reference Bootloaders.md on "make flash" failureKevin O'Connor2019-07-221-4/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix numbering in FAQKevin O'Connor2019-05-081-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update "avr restart=command" FAQ to point to bootloaders.mdKevin O'Connor2019-05-071-2/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using .. in markdown linksKevin O'Connor2019-04-141-20/+23
| | | | | | | 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: Warn against using the TMC2208 in standalone modeKevin O'Connor2019-02-201-10/+39
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: added an answer to the FAQ about detecting lost steps (#1265)christian mock2019-02-171-0/+19
| | | Signed-off-by: christian mock <cm@tahina.priv.at>
* docs: Clarify FAQ item on running multiple instances of klippyKevin O'Connor2019-02-031-1/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording change to step_distance FAQKevin O'Connor2019-01-271-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Expand FAQ on why step_distance is usedKevin O'Connor2019-01-271-0/+8
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ item for "Do I have to use OctoPrint?"Kevin O'Connor2019-01-211-11/+23
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a new Config_Changes.md documentKevin O'Connor2019-01-071-0/+4
| | | | | | | 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 FAQ item for "multiple instances of klipper on the same machine"Kevin O'Connor2019-01-071-11/+29
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Suggest checking for bad wires in "lost communications" faq entryKevin O'Connor2019-01-071-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Documentation/FAQ, Raspii voltageKevin O'Connor2019-01-051-3/+7
| | | | | | | Add note that `under power` may be related to communication issues. Signed-off-by: Wilfried Goesgens <dothebart@citadel.org> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ item on how to cancel a "wait for temperature" requestKevin O'Connor2018-12-201-1/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ item on Raspberry Pi rebootsKevin O'Connor2018-12-201-4/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix link in FAQ documentKevin O'Connor2018-11-131-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Be more clear that a baud of 250000 is recommendedKevin O'Connor2018-11-131-9/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a "Lost communication with MCU" section to the FAQKevin O'Connor2018-10-091-4/+27
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor rewording of Marlin pin number section of FAQKevin O'Connor2018-08-261-13/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a section to the FAQ on translating Marlin pin numbersKevin O'Connor2018-08-241-1/+50
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* force_move: Provide defaults for SET_KINEMATIC_POSITION parametersKevin O'Connor2018-08-021-3/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* toolhead: Replace junction_deviation with square_corner_velocityKevin O'Connor2018-07-161-1/+1
| | | | | | | | The junction_deviation configuration parameter has a number of quirks that make it difficult to configure. Replace it with a "square_corner_velocity" configuration parameter. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation to note use of /dev/serial/by-path/Kevin O'Connor2018-06-011-3/+7
| | | | | | | | When using multiple micro-controllers it may be necessary to use an id from /dev/serial/by-path/ instead of /dev/serial/by-id/. Also, emphasize that in config/example-multi-mcu.cfg. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add reference to homing_override in FAQKevin O'Connor2018-05-201-0/+6
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* FAQ: Add item on TMC2208 being disabled in the middle of a printKevin O'Connor2018-05-051-3/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve FAQ update software entry (use make menuconfig ; make clean)Kevin O'Connor2018-04-251-0/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add more hints to use /dev/by-id/ for the serial deviceKevin O'Connor2018-04-201-9/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add additional information to FAQ on heater checksKevin O'Connor2018-04-091-0/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Patreon link to FAQ pageKevin O'Connor2018-03-311-11/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add "will heaters be turned off on a crash" item to FAQKevin O'Connor2018-03-131-1/+13
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note the use of the virtual_sdcard featureKevin O'Connor2018-03-021-5/+11
| | | | | | Note that virtual_sdcard helps on slower machines. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ item on steps to upgrade the softwareKevin O'Connor2018-01-121-0/+36
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a table of contents to the FAQKevin O'Connor2018-01-051-2/+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 21:53:09 +0000