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

Reworked README & supplimenting docs #512

Merged
merged 6 commits into from
Jan 14, 2024

Conversation

piercemorris
Copy link

Part of this issue.

This can be opinionated but essentially I've moved any large sections to its own documentation, and tried to keep the README slim. I've kept content changes minimal and didn't visit the FAQ section so any comments regarding that would be helpful.

Anything else that can be removed/updated/added revolving the docs I can add it into here no problem!

@piercemorris piercemorris requested a review from a team as a code owner January 6, 2024 22:55
Copy link

github-actions bot commented Jan 6, 2024

✔️ No visual differences introduced by this PR.

View Playwright Report (note: open the "playwright-report" artifact)

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@piercemorris
Copy link
Author

@djahandarie @toasted-nutbread do these changes look good to you?

@toasted-nutbread toasted-nutbread self-requested a review January 11, 2024 01:40
Copy link

@toasted-nutbread toasted-nutbread left a comment

Choose a reason for hiding this comment

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

Can you add newlines to the end of the files that don't have it? A lot of people have settings which auto-format with an empty newline at the end on save which can cause unnecessary git diffs when those are added. (That's probably something that should be a configuration thing for the project settings.)

docs/keyboard-shortcuts.md Outdated Show resolved Hide resolved
@MarvNC
Copy link
Member

MarvNC commented Jan 11, 2024

Can you add newlines to the end of the files that don't have it? A lot of people have settings which auto-format with an empty newline at the end on save which can cause unnecessary git diffs when those are added. (That's probably something that should be a configuration thing for the project settings.)

Maybe prettier? It could also make line breaking more consistent if you enable the proseWrap option.

@piercemorris
Copy link
Author

Can you add newlines to the end of the files that don't have it? A lot of people have settings which auto-format with an empty newline at the end on save which can cause unnecessary git diffs when those are added. (That's probably something that should be a configuration thing for the project settings.)

Adding to what @MarvNC mentioned, I feel like prettier would solve this issue rather than adhoc comments on the PRs - #517. I will make the amendments as you suggested.

Copy link
Collaborator

@djahandarie djahandarie left a comment

Choose a reason for hiding this comment

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

I'm a little skeptical that the subpages will be visible enough for people, I feel like they might get missed when someone is looking for some piece of information. But we can give it a shot. Just left one comment, okay to approve after that.

README.md Outdated Show resolved Hide resolved
@djahandarie djahandarie added this pull request to the merge queue Jan 14, 2024
Merged via the queue into yomidevs:master with commit 326c533 Jan 14, 2024
6 checks passed
@djahandarie djahandarie added the kind/meta The issue or PR is meta label Jan 14, 2024
@Casheeew Casheeew mentioned this pull request Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/meta The issue or PR is meta
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants