Reword and reformat README for idiomaticity and clarity #341
Conversation
This file contains hidden or 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
Contributor
|
Thx a lot for reformatting our readme! 🌹 |
Contributor
|
It seems our second video, which introducing tabby, is removed? And there are two "Quick Start" sections now, which the second should be "Brief Injection Tutorial" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The excessive HTML use made it difficult to read as plaintext, which is counter to Markdown's philosophy. A lot of HTML tags were used when equivalent Markdown syntax existed. For the remaining HTML, I tried to make it semantically sensible, minimizing attempts to control the presentation.
In the process, it did remove manual heading IDs, but doesn't GitHub generate those automatically? I might need to revert headings back to tags.Some names were misspelled, some units used non-standard symbols, many phrases sounded off, the tone at times sounded too excessive. I tried to use my best judgment to guess the intended meaning. If I got anything wrong, let me know.