Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The documentation could be improved a bit more #2

Open
erlis opened this issue Sep 17, 2022 · 6 comments
Open

The documentation could be improved a bit more #2

erlis opened this issue Sep 17, 2022 · 6 comments

Comments

@erlis
Copy link

erlis commented Sep 17, 2022

Please just put 10 more mins on making the documentation a bit clear. The section for menu config is just an image... no steps? What am I supposed to do there? How I get there? Should I Open Menu config before or after flashing?

It looks like this is very simple to setup but with the existing documentation is almost impossible to follow.

Sorry I don't want to be negative but I'm all over the place finding how should I get this going and I feel this is the place where it should be done.

Thanks

@GerogeFu
Copy link
Contributor

GerogeFu commented Nov 9, 2022

I just updated, have a check

@erlis
Copy link
Author

erlis commented Nov 9, 2022

yes, that's better! Thanks for taking the time!

@ahoy
Copy link

ahoy commented Nov 13, 2022

Could the documentation be updated? The menuconfig now has a bootloader option.

@mashmunONE
Copy link

please specify if the bootloader needs to be set, mine can only be flashed via the RPi as mentioned in another issue-ticket.

@Velo555
Copy link

Velo555 commented Aug 21, 2023

Can we add a step file or pdf file with mechanical drawings? Wanted to design some mounts for a friend who does not live in the same state.

@tastyratz
Copy link

Documentation is still very lacking, I had to stumble around to figure some things out:

  1. a new shaper starts in flash mode, holding down the button does nothing till AFTER it's been flashed at least once
  2. You cannot find out the Serial-ID when it's in usb flash/thumb drive mode
  3. Dropping the files on the "thumb drive" flashes the device. You can get them with WINSCP after you build with make. Trying to do this from the PI sucks if you don't know linux
  4. Bootloader options should be left at off/unchecked, screenshot is outdated
  5. "You can remove PIS after you get the [input_shaper] section parameter." This doesn't say enough on it's own. You MUST comment out that include if you unplug PIS or Klipper will not boot!
  6. The PIS.cfg file should have a callback and reference to the github in it. This is just commentary.
  7. The commands are in other git issues but it would be helpful to just have them quick in the instructions over only linking the longer klipper doc. That's a great idea to include in case it changes.

I found a lot of things to do differently based on reported issues here. If I just had the instructions, I would have returned it/tossed the unit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants