Klipper3d / klipper

Klipper is a 3d-printer firmware
GNU General Public License v3.0
8.99k stars 5.17k forks source link

ci: update & simplify docs contributing - docs: update + cosmetics #6468

Open docgalaxyblock opened 5 months ago

docgalaxyblock commented 5 months ago

My start focus was to update all sites regarding the CanBoot -> katapult transition. Stuff I catched on the lines/pages I fixed too.

Changed site can be viewed here: https://docgalaxyblock.github.io/klipper Note: It looks like some cometic customization stuff got not applied

I stopped my work today since the used mkdocs-material version is not uptodate and the official mkdocs-material docs differ a bit. Will try to update mkdocs-material without breaking anything and then update more pages.

Greetings Doc

docgalaxyblock commented 5 months ago

I did not touched the lib/canboot folder. May that be renamed too and a symlink added for legacy docs forks?

@Arksine The lib/README lists a rev I could not find in your katapult repo - how old is the flash_can.py in klipper? Are there be any changes making an update a benefit for the user?

github-actions[bot] commented 4 months ago

Thank you for your contribution to Klipper. Unfortunately, a reviewer has not assigned themselves to this GitHub Pull Request. All Pull Requests are reviewed before merging, and a reviewer will need to volunteer. Further information is available at: https://www.klipper3d.org/CONTRIBUTING.html

There are some steps that you can take now:

  1. Perform a self-review of your Pull Request by following the steps at: https://www.klipper3d.org/CONTRIBUTING.html#what-to-expect-in-a-review If you have completed a self-review, be sure to state the results of that self-review explicitly in the Pull Request comments. A reviewer is more likely to participate if the bulk of a review has already been completed.
  2. Consider opening a topic on the Klipper Discourse server to discuss this work. The Discourse server is a good place to discuss development ideas and to engage users interested in testing. Reviewers are more likely to prioritize Pull Requests with an active community of users.
  3. Consider helping out reviewers by reviewing other Klipper Pull Requests. Taking the time to perform a careful and detailed review of others work is appreciated. Regular contributors are more likely to prioritize the contributions of other regular contributors.

Unfortunately, if a reviewer does not assign themselves to this GitHub Pull Request then it will be automatically closed. If this happens, then it is a good idea to move further discussion to the Klipper Discourse server. Reviewers can reach out on that forum to let you know if they are interested and when they are available.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

KevinOConnor commented 4 months ago

Thanks. I appreciate you taking the time to review and make fixes to the documentation.

As high-level feedback, there are a lot of changes in this PR and a handful of changes look incorrect to me. That makes it hard to review and provide feedback.

I appreciate that you've split this PR into commits (as that helps review). I did see some commits where cosmetic changes (eg, whitespace fixes) were mixed with functional changes (eg, a different path) - that makes it hard to review.

I'll follow up with a few things that I noticed during review.

Thanks again for working on this. -Kevin

github-actions[bot] commented 3 months ago

It looks like this GitHub Pull Request has become inactive. If there are any further updates, you can add a comment here or open a new ticket.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

docgalaxyblock commented 3 months ago

I hope I have got everything now.

Please give your updated opinion on the still open review comments.

Happy 🐇🥚 Doc