docs: Update Home Page and Setup Guides #478
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
SIgned-off-by Paul Cutler [email protected]
meteyou
reviewed
Dec 19, 2021
docs/configurations/necessary-cfg.md
Outdated
| ```yaml | ||
| [display_status] | ||
| ``` | ||
|
|
||
| ## Pause, Resume, Cancel | ||
| This enables pause / resume in mainsail. | ||
| These macros control the current print job. |
There was a problem hiding this comment.
[pause_resume]is only to enable the PAUSE/RESUME commands in klipper...
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
Signed-off-by Paul Cutler [email protected]
… localization Signed-off-by Paul Cutler [email protected]
|
Hi, I've reviewed and edited all of the Update guides. Thank you to whomever wrote the documentation, it's always easier to edit than create! I've tried to improve the spelling and grammar to improve readability. I've also tried to remove contractions (don't vs do not), shorthand (config vs configuration), file names, etc. to make it easier for translators. If there any mistakes or if anything doesn't make sense, please let me know and I'm happy to fix them. I can take the feedback. :) |
meteyou
changed the title
lixxbox
reviewed
Jan 1, 2022
docs/index.md
Outdated
| - Temperature Presets (with custom gcode) | ||
| - Bed Mesh Leveling | ||
| - Multi-Webcam support | ||
| - Control power devices (relays, TPLink, Tasmota, ..) | ||
| - Customizable UI (logos, backgrounds & even custom css) | ||
| - Control power devices such as relays, TPLink and Tasmota devices, and more) |
lixxbox
reviewed
Jan 1, 2022
docs/index.md
Outdated
| - Control power devices (relays, TPLink, Tasmota, ..) | ||
| - Customizable UI (logos, backgrounds & even custom css) | ||
| - Control power devices such as relays, TPLink and Tasmota devices, and more) | ||
| - Customizable user interface includinglogos, backgrounds, and custom CSS |
There was a problem hiding this comment.
includinglogos -> missing whitespace
lixxbox
reviewed
Jan 1, 2022
docs/update-guide/klipper.md
Outdated
| ```bash | ||
| cd ~/klipper | ||
| git pull | ||
| ``` | ||
|
|
||
| Restart Klipper (`sudo service klipper restart`) and check the `klippy.log`, if Klipper starts | ||
| correctly and then continue the guide. | ||
| Restart Klipper using the command `sudo service klipper restart` and check the `klippy.log`. if Klipper startsed correctly without any errors you may continue. |
|
Thanks! Sorry I missed some of these. I'll get the changes in by tomorrow. |
lixxbox
suggested changes
Jan 1, 2022
Signed-off-by Paul Cutler [email protected]
lixxbox
approved these changes
Jan 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
These are my first commits to Mainsail's docs, so if I didn't do something right or you don't like the changes, I won't be offended! :) Just let me know what you would like changed and I'm happy to help.
I've gone through the home page and the setup guide for edits. As I'm getting used to the tone and style of the docs, I just start by reading and updating what's there.
Generally the way I've been taught is think about translations and accessibility when writing docs. I try to limit contractions (don't vs do not), use simpler language to make it easier for translation, and limit parentheses ().
I'll keep reviewing and sending some edits in and then I'll start helping write some of the newer chapters for the next release.
Thanks for reviewing and let me know the feedback for what I should change.