65 Commits
Author SHA1 Message Date
Satvik Mishra 6c8e313283 docs: Fix broken internal links and anchors
Several links pointed at heading anchors that no longer exist (renamed
or moved sections), so they did not jump to the intended section.
Update them to the current anchors, and use a relative path for the
sample-pwm-tool.cfg link so it resolves like the other config links.

Signed-off-by: Satvik Mishra <Satvikmishra.ipu146183@maims.ac.in>
2026-10-12 20:15:44 -04:00
Kevin O'Connor ad425fc22e docs: Fix spelling error in FAQ.md
Reported by @reitermarkus.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2026-09-17 12:26:59 -04:00
Kevin O'Connor f3db41c637 docs: Update FAQ now that heaters have a MAX_HEAT_TIME of 3 seconds
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2026-04-08 16:06:57 -04:00
JamesH1978 b1dd6a73f7 docs: Update FAQ.md - Typo (#7089)
Kliper is not Klipper!

Signed-off-by: James Hartley <james@hartleyns.com>
2025-10-13 13:53:13 -04:00
JamesH1978 bab5f8031c docs: Update FAQ.md - Recomendation adjustment (#7025)
This doc still says the Pi 2 is an option for Klipper, in this day and age, i am not sure it is. From anecdotal evidence, the lowest pi recommended should be the zero2w. I also changed the wording and removed some Octoprint wording in that section to better reflect how things are today, as i don't think even with virtual_sdcard these older devices will keep up.

Signed-off-by: James Hartley <james@hartleyns.com>
2025-08-31 14:26:15 -04:00
Kevin O'Connor 2f9fe49cb8 docs: Add a Sponsors.md file
Add a documentation page with information on how to support Klipper.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-07-16 10:48:10 -04:00
Yifei Ding ae17b66a88 docs: remove FAQ ToC (#5585)
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2022-06-27 09:58:48 -04:00
Yifei Ding 7d57a7c4c8 docs: Various minor fixes (#5175)
Signed-off-by: Yifei Ding<yifeiding@protonmail.com
2022-01-26 18:00:18 -05:00
Yifei Ding dd714fc7a1 docs: Update raspberrypi.com Links in FAQ
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-12-15 22:21:48 -05:00
Yifei Ding a1af78cb83 docs: Rename Documents
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-22 21:03:32 -05:00
Kevin O'Connor bd0185cf75 docs: Don't use section-index plugin during klipper3d.org site generation
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>
2021-08-17 19:39:23 -04:00
Damien cff61605fb docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.

Signed-off-by: Damien Martin <damlobster@gmail.com>

Update CNAME
2021-07-27 13:15:25 -04:00
Kevin O'Connor dc55142437 docs: Update FAQ on which mcus have hard pwm support
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-26 12:39:47 -04:00
Kevin O'Connor 4f66a467e3 config: Create new sample-aliases.cfg with standard aliases
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>
2021-03-25 10:49:17 -04:00
Kevin O'Connor 5b31080e77 docs: Add a Rotation_Distance.md document
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-12-18 10:30:32 -05:00
Kevin O'Connor 7dcc778b6c stepper: Calculate step_distance from rotation_distance
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>
2020-12-18 10:30:32 -05:00
Kevin O'Connor 1f2d9c051c docs: Use relative links for files outside the docs/ directory
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>
2020-12-03 15:06:58 -05:00
Kevin O'Connor 15b5dbaf8f docs: Move config reference information to new Config_Reference.md
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>
2020-11-18 20:10:21 -05:00
Kevin O'Connor 2bb6b0f58f docs: Expand on host computer restrictions in the FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-08-26 10:11:21 -04:00
Elton Law fe84968bdc docs: Add uninstall notes to faq
From comments in https://github.com/KevinOConnor/klipper/issues/1084

This documents the script added in 0ba1f5109d

Signed-off-by: Elton Law <eltonlaw296@gmail.com>
2020-08-03 14:16:34 -04:00
Kevin O'Connor e4d0044be8 docs: Add a "hardware pin type" section to the FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-07-16 13:04:00 -04:00
Kevin O'Connor 7912c39f9e docs: Add a "why does klipper report errors" section to FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-06-05 17:04:02 -04:00
Kevin O'Connor 3c01b60a88 docs: Update FAQ with TMC2208 "standalone" mode workaround
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-03-29 11:08:49 -04:00
Kevin O'Connor 5ff45636d9 docs: Minor FAQ updates
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>
2020-01-06 10:45:48 -05:00
Kevin O'Connor 8663bc8192 docs: Update FAQ to emphasize checking Config_Changes.md on an upgrade
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-12-10 13:51:47 -05:00
Kevin O'Connor 205da598fd docs: Move upgrade instructions to the last item in the FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-12-10 13:39:49 -05:00
Kevin O'Connor 3665e9fc53 docs: Recommend safe_z_home over homing_override
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>
2019-11-07 16:50:52 -05:00
Kevin O'Connor 197030c684 docs: Update FAQ to reference Bootloaders.md on "make flash" failure
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-07-22 10:07:34 -04:00
Kevin O'Connor fd1dff3f02 docs: Fix numbering in FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-05-08 16:48:14 -04:00
Kevin O'Connor 73fd292637 docs: Update "avr restart=command" FAQ to point to bootloaders.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-05-07 23:02:20 -04:00
Kevin O'Connor 8bc9f39c58 docs: Avoid using .. in markdown links
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>
2019-04-14 21:12:21 -04:00
Kevin O'Connor 328bd89fc1 docs: Warn against using the TMC2208 in standalone mode
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-20 16:22:06 -05:00
christian mock 82efed5e2a docs: added an answer to the FAQ about detecting lost steps (#1265)
Signed-off-by: christian mock <cm@tahina.priv.at>
2019-02-17 22:35:58 -05:00
Kevin O'Connor 5b9ce328e5 docs: Clarify FAQ item on running multiple instances of klippy
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-03 17:41:57 -05:00
Kevin O'Connor 90827a88de docs: Minor wording change to step_distance FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-27 16:52:16 -05:00
Kevin O'Connor 71ef715a88 docs: Expand FAQ on why step_distance is used
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-27 11:29:42 -05:00
Kevin O'Connor 76138fde5c docs: Add a FAQ item for "Do I have to use OctoPrint?"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-21 12:01:24 -05:00
Kevin O'Connor f2f54290e8 docs: Add a new Config_Changes.md document
Add a document to track non-backwards compatible changes to the
printer config file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-07 20:00:44 -05:00
Kevin O'Connor c8e04274ad docs: Add a FAQ item for "multiple instances of klipper on the same machine"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-07 13:59:52 -05:00
Kevin O'Connor 28e68075c8 docs: Suggest checking for bad wires in "lost communications" faq entry
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-01-07 10:28:25 -05:00
Kevin O'Connor 186d815469 docs: Documentation/FAQ, Raspii voltage
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>
2019-01-05 20:59:12 -05:00
Kevin O'Connor d7b0a7e961 docs: Add a FAQ item on how to cancel a "wait for temperature" request
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-12-20 16:25:58 -05:00
Kevin O'Connor 566488dc01 docs: Add a FAQ item on Raspberry Pi reboots
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-12-20 16:25:58 -05:00
Kevin O'Connor 097e6c524b docs: Fix link in FAQ document
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-13 14:40:35 -05:00
Kevin O'Connor 5f9ce32fae docs: Be more clear that a baud of 250000 is recommended
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-11-13 14:06:27 -05:00
Kevin O'Connor 1e07be4db4 docs: Add a "Lost communication with MCU" section to the FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-10-09 11:22:28 -04:00
Kevin O'Connor 96acfdc6d2 docs: Minor rewording of Marlin pin number section of FAQ
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-26 23:06:32 -04:00
Kevin O'Connor a27e82aef3 docs: Add a section to the FAQ on translating Marlin pin numbers
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-24 21:43:53 -04:00
Kevin O'Connor f2d232ef77 force_move: Provide defaults for SET_KINEMATIC_POSITION parameters
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-08-02 08:58:18 -04:00
Kevin O'Connor 0025fbf10d toolhead: Replace junction_deviation with square_corner_velocity
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>
2018-07-16 10:32:43 -04:00