Small change to Resonance Documentation

Basic Information:

klippy.log (56 Bytes)
Printer Model: Any
MCU / Printerboard: Any
Host / SBC: Pi Family
klippy.log

Describe your issue:

Pardon me if this isn’t the best place to put these kinds of requests, but I am not sure if this really counts as a feature request - it’s just a documentation change.

I am following the Measuring Resonances guide, using a Raspberry Pi 3 and a MPU-6000/9000-type IMU. Carefully following the guide, I got to the section that describes software configuration (begins at #configure-adxl345-with-rpi). Since i am using the Pi MCU and MPU-6000, I skipped down to that section. However, in doing so, I missed the crucial step of “flashing” and activating the Pi MCU. As a result, the instructions do not strictly work as listed. The proper procedure is listed in the document though, in the " Configure ADXL345 With RPi" section.

I propose moving the instructions describing setting up the Pi MCU to a new section, directly above the " Configure ADXL345 With RPi" section, titled “Configuring the Pi MCU” or similar. In addition to solving the problem I mentioned, it would decouple the process of configuring the Pi MCU from configuring an accelerometer, which seems like a logical division. It may make sense to do the same with the Pico setup, but I have not gone through that process so I have no experience there.

This is the kind of simple change that I would be happy to do myself but I have never contributed to Klipper before so I would want to know what the accepted courtesies/procedures are for that, as well as to hear if anyone else has input on whether my suggestions make sense. Otherwise, if there is some general curator for these docs, it should be a <10 minute fix to reformat the doc.

Thanks for reading, and thanks to everyone who has contributed to Klipper - it’s fantastic!

1 Like

Thanks for the feedback. You are probably right that the documentation there could use some love.
There are no “dedicated documentation caretakers”, so it is like many (most) OSS projects: It depends on the voluntary contributions of interested people.
In this sense, every contribution (Pull Request on GitHub) that improves the documentation is highly welcome.

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.