Improve Lawnchair documentation #4370
Conversation
"Fix NullCube's tomfoolery"
Co-authored-by: Pun Butrach <pun.butrach@gmail.com>
Proofread CONTRIBUTING.md
Signed-off-by: validcube <pun.butrach@gmail.com>
…to pave-path Signed-off-by: validcube <pun.butrach@gmail.com>
Signed-off-by: validcube <pun.butrach@gmail.com>
Final proofread
Script Execution UTC Time: 2024-05-17T17:02:33.603063+00:00 Signed-off-by: validcube <pun.butrach@gmail.com>
Script Execution UTC Time: 2024-05-17T17:05:58.625257+00:00 Signed-off-by: validcube <pun.butrach@gmail.com>
There was a problem hiding this comment.
Nice work on adding documentation! Apologies for the delay in reviewing as well.
While the text is mostly great, I'd suggest several changes to make it more consistent with Lawnchair’s tone and clarify some text.
For CONTRIBUTING.md, it would also be nice for us to include some chats in Discord/Telegram for help. We don't really need to bold all instances of LAWNCHAIR either.
Lastly, please add newlines to the end of the files if there isn't already.
Once again, thanks for the PR!
Co-authored-by: SuperDragonXD <70206496+SuperDragonXD@users.noreply.github.com>
README.md
Outdated
| <source media="(prefers-color-scheme: dark)" srcset="docs/device-frame.png" width="15%"> | ||
| <img alt="Google Pixel running Lawnchair Launcher with green wallpaper" src="docs/device-frame.png" width="15%"> |
There was a problem hiding this comment.
Just tested it on small devices, and it's quite small due to the 15% width.
How about we hardcode it to about 250-300px in width? I personally prefer 300px, as it matches the Lawnchair website.
There was a problem hiding this comment.
250px seems to be a good size for this
Description
This PR aims to improve the documentation of Lawnchair by creating a
CONTRIBUTING.mdand modifying the existing markdown files.Type of change
✅ General change (non-breaking change that doesn't fit the below categories like copyediting)
❌ Bug fix (non-breaking change which fixes an issue)
❌ New feature (non-breaking change which adds functionality)
❌ Breaking change (fix or feature that would cause existing functionality to not work as expected)