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

Improve Lawnchair Documentation v3 #4644

Merged
merged 32 commits into from
Aug 20, 2024

Conversation

validcube
Copy link
Contributor

@validcube validcube commented Aug 10, 2024

Description

Improve even more documentation!!

Remove unused prebuilt jars!!!

  • Add new device mockups (the old one is not actually usable due to copyright)

  • Sanity check by someone not me!!!

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)

@validcube validcube marked this pull request as ready for review August 10, 2024 14:18
@validcube validcube changed the title Improve Documentation v3 Improve Lawnchair Documentation v3 Aug 10, 2024
@validcube validcube marked this pull request as draft August 10, 2024 14:31
@MrSluffy MrSluffy self-requested a review August 11, 2024 13:00
@MrSluffy
Copy link
Member

since this is still a draft, please don' t remove the jars, as it's for reference if there's an issue in lower version. Thanks!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
@validcube
Copy link
Contributor Author

since this is still a draft, please don' t remove the jars, as it's for reference if there's an issue in lower version. Thanks!

Done:tm: (by @JovannMC)

@validcube validcube marked this pull request as ready for review August 14, 2024 07:17
@SuperDragonXD SuperDragonXD requested review from SuperDragonXD and removed request for MrSluffy August 15, 2024 11:51
Copy link
Collaborator

@SuperDragonXD SuperDragonXD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. I’ve requested some minor formatting changes to make things more consistent.

Regarding the CSS files, could you provide a valid usecase for this? I think a document containing hex codes, especially for the source color, would be more useful.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
build.gradle Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@validcube
Copy link
Contributor Author

Thanks for the PR. I’ve requested some minor formatting changes to make things more consistent.

Regarding the CSS files, could you provide a valid usecase for this? I think a document containing hex codes, especially for the source color, would be more useful.

The CSS files, this is awkward, I'm sure not why this was exactly added, but I was debating myself wherever to include hex code or a CSS file instead.

At the time, I went with including CSS file exported from Figma using the Google Material Design 3 Plugin to ensures exact colour scheme when designing visual.

If you find hex code more useful, let's me know!

@SuperDragonXD
Copy link
Collaborator

SuperDragonXD commented Aug 18, 2024

I think a hex code for Lawnchair’s source color will be more useful. We can always provide a link to the Material 3 Theme Builder if needed.

Here’s an example description you can improve upon; just replace the XXXXXX with Lawnchair's source color:

All assets created should use Material 3 design with `#XXXXXX` as source color and the [Inter](https://fonts.google.com/specimen/Inter) ([OFL v1.1](https://github.com/rsms/inter/?tab=OFL-1.1-1-ov-file#readme)) typography. Visit the [Material 3 theme builder](http://material-foundation.github.io?primary=%XXXXXX00&bodyFont=Inter&displayFont=Inter&colorMatch=false) for more information.

@SuperDragonXD SuperDragonXD merged commit 981a6bb into LawnchairLauncher:14-dev Aug 20, 2024
5 checks passed
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

Successfully merging this pull request may close these issues.

4 participants