-
Notifications
You must be signed in to change notification settings - Fork 112
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
Conversation
✔️ No visual differences introduced by this PR. View Playwright Report (note: open the "playwright-report" artifact) |
@djahandarie @toasted-nutbread do these changes look good to you? |
There was a problem hiding this 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.)
Maybe prettier? It could also make line breaking more consistent if you enable the |
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. |
There was a problem hiding this 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.
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!