You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/quick-start.mdx
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,18 +19,18 @@ Fix typos, broken links, and small issues directly in your browser—no setup re
19
19
20
20
Every documentation page has an **Edit this page** link at the bottom. This is the fastest way to contribute.
21
21
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.
24
24
25
25
GitHub opens the file in a web-based editor.
26
26
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__:
30
30
1. In the side panel, click the **Source Control** button (looks like a branch icon).
31
31
1. Add a brief description of what you changed (e.g., "Fix typo in installation steps").
32
32
1. Click "Commit & Push".
33
-
6.**Create a pull request**:
33
+
6.__Create a pull request__:
34
34
1. Review the changes one more time.
35
35
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).
36
36
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'
64
64
65
65
## What happens next
66
66
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
68
68
- Style checks (Vale)
69
69
- Link validation
70
70
- 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!
74
74
75
75
## Common contributor concerns (and why you don't need to worry)
76
76
@@ -81,9 +81,9 @@ For quick fixes like typos and link updates, no testing is required. The automat
81
81
### What if the automated checks fail?
82
82
83
83
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
87
87
88
88
### Can I edit multiple pages at once?
89
89
@@ -95,9 +95,9 @@ Yes, but only once. Before your first contribution can be merged, you'll be prom
95
95
96
96
## Need help?
97
97
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
0 commit comments