docs: improve readability with additional subheaders #33168
+16
−9
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
This comment has been minimized.
This comment has been minimized.
pengooseDev
force-pushed
the
docs-readability-subheaders
branch
from
a17bcd4
to
4c6c539
Compare
This comment has been minimized.
This comment has been minimized.
dgozman
reviewed
Oct 18, 2024
CONTRIBUTING.md
Outdated
| @@ -28,14 +30,10 @@ npx playwright install | |||
|
|
|||
| Playwright is a multi-package repository that uses npm workspaces. For browser APIs, look at [`packages/playwright-core`](https://github.com/microsoft/playwright/blob/main/packages/playwright-core). For test runner, see [`packages/playwright`](https://github.com/microsoft/playwright/blob/main/packages/playwright). | |||
|
|
|||
| Note that some files are generated by the build, so the watch process might override your changes if done in the wrong file. For example, TypeScript types for the API are generated from the [`docs/src`](https://github.com/microsoft/playwright/blob/main/docs/src). | |||
| ### TypeScript Type Generation | |||
There was a problem hiding this comment.
I guess it makes sense to put this after Write documentation. Or perhaps combine them? As you put it here, it seems like the most important part of making a change is to "generate types". In practice, you edit docs and everything just happens automatically 😄
pengooseDev
force-pushed
the
docs-readability-subheaders
branch
from
4c6c539
to
4d1aeb8
Compare
This comment has been minimized.
This comment has been minimized.
Test results for "tests 1"1 flaky35085 passed, 618 skipped Merge workflow run. |
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.
Description
Following #33138
Additionally, I wonder if moving the
Lintingsection to the end of## Make a changewould improve the flow. (> link)Since functional changes often impact types, placing
TypeScript Type GenerationandWrite documentationtogether might enhance accessibility.I would appreciate feedback. If there are any changes needed, I'm happy to make them. :)