-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
docs: improve readability with additional subheaders #33168
base: main
Are you sure you want to change the base?
docs: improve readability with additional subheaders #33168
Conversation
This comment has been minimized.
This comment has been minimized.
a17bcd4
to
4c6c539
Compare
This comment has been minimized.
This comment has been minimized.
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.
Thank you for the PR!
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 😄
4c6c539
to
4d1aeb8
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
c20064d
to
76b16ff
Compare
Test results for "tests 1"2 flaky36433 passed, 639 skipped Merge workflow run. |
@@ -45,6 +38,20 @@ Various other files are generated from the API specification. If you are running | |||
|
|||
Larger changes will require updates to the documentation guides as well. This will be made clear during the code review. | |||
|
|||
### TypeScript Type Generation | |||
|
|||
If your changes involve `TypeScript types`, ensure to modify the corresponding files in [`utils/generate_types`](https://github.com/microsoft/playwright/blob/main/utils/generate_types). |
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.
Wait, you are not supposed to edit utils/generate_types
at all. Only the docs/src
.
Description
Following #33138
Additionally, I wonder if moving the
Linting
section to the end of## Make a change
would improve the flow. (> link)Since functional changes often impact types, placing
TypeScript Type Generation
andWrite documentation
together might enhance accessibility.I would appreciate feedback. If there are any changes needed, I'm happy to make them. :)