Unverified Commit 2aefd051 authored by Razin Shafayet's avatar Razin Shafayet Committed by GitHub

docs: fix typos in contribution guide (#94375)

Fixed `search from` → `search for` and `at the of the page` → `at the
top of the page` (confirmed by checking API ref pages — overview tables
go at the top after a short intro and example).
parent b58d9840
...@@ -34,7 +34,7 @@ The docs are written in [MDX](https://mdxjs.com/), a markdown format that suppor ...@@ -34,7 +34,7 @@ The docs are written in [MDX](https://mdxjs.com/), a markdown format that suppor
VSCode has a built-in markdown previewer that you can use to see your edits locally. To enable the previewer for MDX files, you'll need to add a configuration option to your user settings. VSCode has a built-in markdown previewer that you can use to see your edits locally. To enable the previewer for MDX files, you'll need to add a configuration option to your user settings.
Open the command palette (`⌘ + ⇧ + P` on Mac or `Ctrl + Shift + P` on Windows) and search from `Preferences: Open User Settings (JSON)`. Open the command palette (`⌘ + ⇧ + P` on Mac or `Ctrl + Shift + P` on Windows) and search for `Preferences: Open User Settings (JSON)`.
Then, add the following line to your `settings.json` file: Then, add the following line to your `settings.json` file:
...@@ -396,7 +396,7 @@ While we don't have a strict template for pages, there are page sections you'll ...@@ -396,7 +396,7 @@ While we don't have a strict template for pages, there are page sections you'll
- **Overview:** The first paragraph of a page should tell the user what the feature is and what it's used for. Followed by a minimum working example or its API reference. - **Overview:** The first paragraph of a page should tell the user what the feature is and what it's used for. Followed by a minimum working example or its API reference.
- **Convention:** If the feature has a convention, it should be explained here. - **Convention:** If the feature has a convention, it should be explained here.
- **Examples**: Show how the feature can be used with different use cases. - **Examples**: Show how the feature can be used with different use cases.
- **API Tables**: API Pages should have an overview table at the of the page with jump-to-section links (when possible). - **API Tables**: API Pages should have an overview table at the top of the page with jump-to-section links (when possible).
- **Next Steps (Related Links)**: Add links to related pages to guide the user's learning journey. - **Next Steps (Related Links)**: Add links to related pages to guide the user's learning journey.
Feel free to add these sections as needed. Feel free to add these sections as needed.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment