Skip to content

Commit a35405a

Browse files
committed
Syntax fixes
1 parent 79e111d commit a35405a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/contributing/quick-start.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ Fix typos, broken links, and small issues directly in your browser—no setup re
1919

2020
Every documentation page has an **Edit this page** link at the bottom. This is the fastest way to contribute.
2121

22-
1. **Find the issue**: Navigate to the page with the problem.
23-
2. **Click "Edit this page"**: Located at the bottom of every doc page.
22+
1. __Find the issue__: Navigate to the page with the problem.
23+
2. __Open the editor__: Click **Edit this page**, located at the bottom of every doc page.
2424

2525
GitHub opens the file in a web-based editor.
2626

27-
3. **Make your changes**: Edit the Markdown file directly in the browser to fix the issue.
28-
4. **Preview your changes**: Open a preview panel (Ctrl+Shift+V) to see how it looks.
29-
5. **Commit your changes**:
27+
3. __Make your changes__: Edit the Markdown file directly in the browser to fix the issue.
28+
4. __Preview your changes__: Open a preview panel (Ctrl+Shift+V) to see how it looks.
29+
5. __Commit your changes__:
3030
1. In the side panel, click the **Source Control** button (looks like a branch icon).
3131
1. Add a brief description of what you changed (e.g., "Fix typo in installation steps").
3232
1. Click "Commit & Push".
33-
6. **Create a pull request**:
33+
6. __Create a pull request__:
3434
1. Review the changes one more time.
3535
1. In the Source Control panel, click the **Create Pull Request** button (looks like a vertical line with dots on both ends with an arrow pointing to the top and a plus sign).
3636
1. Enter a name and description for the pull request.
@@ -64,13 +64,13 @@ For different issues across different pages, create separate pull requests—it'
6464

6565
## What happens next
6666

67-
1. **Automated checks**: Our CI/CD pipeline runs automated checks on your contribution
67+
1. __Automated checks__: Our CI/CD pipeline runs automated checks on your contribution
6868
- Style checks (Vale)
6969
- Link validation
7070
- Build verification
71-
2. **Review**: A maintainer reviews your changes (usually within 2 business days)
72-
3. **Feedback**: If changes are needed, the reviewer will comment on your pull request
73-
4. **Merge**: Once approved, your contribution is merged and goes live!
71+
2. __Review__: A maintainer reviews your changes (usually within 2 business days)
72+
3. __Feedback__: If changes are needed, the reviewer will comment on your pull request
73+
4. __Merge__: Once approved, your contribution is merged and goes live!
7474

7575
## Common contributor concerns (and why you don't need to worry)
7676

@@ -81,9 +81,9 @@ For quick fixes like typos and link updates, no testing is required. The automat
8181
### What if the automated checks fail?
8282

8383
Don't worry! The reviewer will help you fix any issues. Most common failures are easily correctable:
84-
- **Vale failures**: Usually suggest alternative wording (often just suggestions)
85-
- **Link check failures**: Means a link is broken or inaccessible
86-
- **Build failures**: Usually means there's a syntax error in Markdown
84+
- __Vale failures__: Usually suggest alternative wording (often just suggestions)
85+
- __Link check failures__: Means a link is broken or inaccessible
86+
- __Build failures__: Usually means there's a syntax error in Markdown
8787

8888
### Can I edit multiple pages at once?
8989

@@ -95,9 +95,9 @@ Yes, but only once. Before your first contribution can be merged, you'll be prom
9595

9696
## Need help?
9797

98-
- **Questions about the change?** Ask in the pull request comments
99-
- **Not sure what to change?** Join our [Discord server](https://discord.gg/2M7wXEThfF)
100-
- **Found a bigger issue?** Consider a [standard contribution](standard-contributions) instead
98+
- __Questions about the change?__ Ask in the pull request comments
99+
- __Not sure what to change?__ Join our [Discord server](https://discord.gg/2M7wXEThfF)
100+
- __Found a bigger issue?__ Consider a [standard contribution](standard-contributions) instead
101101

102102
## Ready for more?
103103

0 commit comments

Comments
 (0)