docs: README.md cleanup, content reorganization
#691
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
claymcleod
force-pushed
the
docs/readme-update
branch
2 times, most recently
from
894326b to
c43ffa1
Compare
|
I also took a shot at updating some of the colors. I'm not sure if I like that yet. Here are some more options using close to the existing colors.
|
claymcleod
changed the title
README.md cleanup, content reorganizationREADME.md cleanup, content reorganization
claymcleod
force-pushed
the
docs/readme-update
branch
from
c43ffa1 to
9acbffa
Compare
claymcleod
force-pushed
the
docs/readme-update
branch
8 times, most recently
from
74dcecc to
33c119b
Compare
|
I ended up just using the existing colors as I showed in the examples above. This should now be ready for review. |
jdidion
requested changes
Jan 13, 2025
claymcleod
force-pushed
the
docs/readme-update
branch
2 times, most recently
from
82463a8 to
021ab41
Compare
|
@jdidion I think everything has been addressed here. |
claymcleod
changed the title
README.md cleanup, content reorganizationREADME.md cleanup, content reorganization
This commit is the squashed product of the following commits: * docs: adds `README.md` header image * docs: updates `README.md` with new information, deduplicates content * revise: add @jdidion's suggestions * revise: one sentence per line Co-authored-by: John Didion <[email protected]>
claymcleod
force-pushed
the
docs/readme-update
branch
from
021ab41 to
d85effc
Compare
|
Note that I plan to make further changes to the fonts, etc, in the future. For now, I'll merge this in as it's a big improvement. |
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.
This pull request cleans up the
README.mdsignificantly and with the aim of pushing a decent amount of the content to the website (a future PR is planned for that). The idea is that content should only live in one place—not be duplicated between theREADME.mdand the website—and that theREADME.mdis just the entrypoint to this content (it does not need to cover every detail and historical fact).I also took the liberty of selecting a font for the
README.mdheader, which is, in some ways, a suggestion for a font for assets from the project as a whole. In this case, I chose Metropolis, which is made available under the UNLICENSE.Checklist