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: CONTRIBUTING.md
+15-33Lines changed: 15 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,21 @@
2
2
3
3
Thank you for helping us make this project great and being a part of the Solid community!
4
4
5
-
We welcome contributions from anyone, regardless of your skill level.
6
-
We are happy to help with guidance on PRs, technical writing, and turning features into realities.
5
+
We welcome contributions from anyone, regardless of your skill level. We are happy to help with guidance on PRs, technical writing, and turning features into realities.
7
6
8
-
> **New to contributing?**
9
-
> Take a look at [this GitHub guide](https://docs.github.com/en/get-started/start-your-journey/hello-world) to learn how to use Git and GitHub to contribute to open-source.
7
+
> **New to contributing?** Take a look at [this GitHub guide](https://docs.github.com/en/get-started/start-your-journey/hello-world) to learn how to use Git and GitHub to contribute to open-source.
10
8
11
9
If you're new to Solid, we ask that you check out our [Writing Guide](https://github.com/solidjs/solid-docs-next/blob/main/WRITING.md).
12
10
13
11
## Types of contributions
14
12
15
13
There are many ways to contribute to the Solid's documentation!
16
14
17
-
The Solid Docs website is built on Solid!
18
-
Maintaining it requires not only written content and Solid code maintenance, but it also needs to address accessibility (a11y), CSS, UI, and UX concerns.
19
-
We also aim to make our documentation available in several languages, so we need help translating the entire site.
15
+
The Solid Docs website is built on Solid! Maintaining it requires not only written content and Solid code maintenance, but it also needs to address accessibility (a11y), CSS, UI, and UX concerns. We also aim to make our documentation available in several languages, so we need help translating the entire site.
20
16
21
17
You can help out by leaving review comments on [PRs](https://github.com/solidjs/solid-docs-next/pulls) and adding ideas in existing GitHub [issues ](https://github.com/solidjs/solid-docs-next/issues) and [discussions](https://github.com/solidjs/solid-docs-next/discussions).
22
18
23
-
Every PR, especially translation PRs, will need reviewers.
24
-
Reviewing PRs and leaving comments, suggestions, or even saying "Looks good!" can be a great way to get started on contributing alongside our Docs team.
25
-
It's also a great way to learn more about Solid!
19
+
Every PR, especially translation PRs, will need reviewers. Reviewing PRs and leaving comments, suggestions, or even saying "Looks good!" can be a great way to get started on contributing alongside our Docs team. It's also a great way to learn more about Solid!
26
20
27
21
We encourage you to:
28
22
@@ -71,8 +65,7 @@ We use labels as a way to organize and categorize our issues. Here are some comm
71
65
72
66
## Start a discussion
73
67
74
-
Discussions are a place within this repository where we can have open-ended conversations.
75
-
It's the perfect place for Q&A, sharing ideas, community engagement, and connecting with other members.
68
+
Discussions are a place within this repository where we can have open-ended conversations. It's the perfect place for Q&A, sharing ideas, community engagement, and connecting with other members.
76
69
77
70
Feel free to start a [new discussion](https://github.com/solidjs/solid-docs-next/discussions) on any topic related to our docs!
78
71
@@ -87,25 +80,22 @@ Feel free to start a [new discussion](https://github.com/solidjs/solid-docs-n
87
80
88
81
> If you've never submitted a pull request on GitHub before, check out [this overview on how to open a PR](https://opensource.guide/how-to-contribute/#opening-a-pull-request).
89
82
90
-
PRs are the heart of collaboration on GitHub.
91
-
When you open a pull request, you are putting forward your suggested changes, inviting us to review it, and requesting for these changes to be merged into our main branch.
83
+
PRs are the heart of collaboration on GitHub. When you open a pull request, you are putting forward your suggested changes, inviting us to review it, and requesting for these changes to be merged into our main branch.
92
84
93
85
Here's how to effectively contribute via a PR:
94
86
95
87
-**Understand the Scope**: Before creating a PR, ensure it addresses an existing issue. Remember to link your PR to the issue it solves for easy tracking and understanding.
96
88
-**Singular Focus**: Each PR should address a single issue or enhancement. Want to propose a larger change? Reach out to us on [Discord](https://discord.com/invite/solidjs) and let's discuss the best way forward!
97
89
-**Drafts for Early Feedback**: If you're seeking early feedback but aren't quite finished with your changes, consider creating a draft PR. Simply prefix your PR title with `**[Draft]**`. This way, you can get input on your work-in-progress.
98
-
-**Quality over Quantity**: Strive for the quality of your contribution rather than the quantity. A well-thought-out, cleanly coded, and thoroughly tested PR is much more valuable than a hastily done large one.
99
-
Contributing via PRs not only enhances the project, but also allows you to be a part of the active community, sharing ideas, learning, and growing with the project.
90
+
-**Quality over Quantity**: Strive for the quality of your contribution rather than the quantity. A well-thought-out, cleanly coded, and thoroughly tested PR is much more valuable than a hastily done large one. Contributing via PRs not only enhances the project, but also allows you to be a part of the active community, sharing ideas, learning, and growing with the project.
100
91
101
92
> Existing PRs and Issues need reviewing, triaging, and feedback, too! You can make valuable contributions by commenting, suggesting, testing, researching, brainstorming and generally helping in all areas!
102
93
103
94
### Writing a PR
104
95
105
96
> Need help making a PR? [Join us on Discord](https://discord.com/invite/solidjs), we'll be more than happy to help you out!
106
97
107
-
Contributions to the documentation site are made by editing the docs repository.
108
-
You can do this directly on GitHub.com or by creating a copy of the repository locally, making your changes there, and contributing back to our repository.
98
+
Contributions to the documentation site are made by editing the docs repository. You can do this directly on GitHub.com or by creating a copy of the repository locally, making your changes there, and contributing back to our repository.
109
99
110
100
#### Examples of helpful PRs
111
101
@@ -115,11 +105,9 @@ You can do this directly on GitHub.com or by creating a copy of the repository l
115
105
116
106
### Edit this page via GitHub
117
107
118
-
Every page on [docs.solidjs.com](https://docs.solidjs.com/) has an **Edit this page** link at the bottom.
119
-
You can click on that button to edit the source code for that page in **GitHub**.
108
+
Every page on [docs.solidjs.com](https://docs.solidjs.com/) has an **Edit this page** link at the bottom. You can click on that button to edit the source code for that page in **GitHub**.
120
109
121
-
After you make your changes, click **Commit changes**.
122
-
This will automatically create a [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) of the docs in your GitHub account with the changes.
110
+
After you make your changes, click **Commit changes**. This will automatically create a [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) of the docs in your GitHub account with the changes.
123
111
124
112
Once you have committed your edits within your fork, follow the prompts to create a **pull request** and submit your changes for review.
125
113
@@ -153,13 +141,11 @@ To translate a new entry to an existing language, go to `src/routes/{locale}` an
153
141
154
142
Once you have made your changes using your preferred method, you're ready to create a 'pull request'.
155
143
156
-
This will let the Solid docs team know you have some changes you would like to propose.
157
-
At this point, we can give you feedback and possibly request changes.
144
+
This will let the Solid docs team know you have some changes you would like to propose. At this point, we can give you feedback and possibly request changes.
158
145
159
146
[Read more about making a pull request in GitHub's docs.](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project#making-a-pull-request)
160
147
161
-
Please include a clear title.
162
-
The description will have some pre-filled questions that we would like you to answer.
148
+
Please include a clear title. The description will have some pre-filled questions that we would like you to answer.
163
149
164
150
Every pull request generates a preview of the site, including your proposed changes, using **Netlify** for anyone to see.
165
151
@@ -171,21 +157,17 @@ The docs site will be automatically updated whenever pull requests are merged.
171
157
172
158
### Forks
173
159
174
-
On GitHub, you will need a 'fork' of this repository to work on.
175
-
This is your own copy of the code base where you can make changes. You can read more about forks in [GitHub's documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
160
+
On GitHub, you will need a 'fork' of this repository to work on. This is your own copy of the code base where you can make changes. You can read more about forks in [GitHub's documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
176
161
177
-
Not sure how to get started with GitHub, forks, pull requests, or want a refresher?
178
-
You can watch this video series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
162
+
Not sure how to get started with GitHub, forks, pull requests, or want a refresher? You can watch this video series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
179
163
180
164
#### Creating a fork
181
165
182
166
To create your copy, click the `Fork` button at the top right of any page in this repository.
183
167
184
168
#### Maintaining a fork
185
169
186
-
When you first create your fork, it will be an exact copy of this repository.
187
-
Over time, our docs will change as they are updated, but your fork won’t automatically stay up-to-date.
188
-
Here are some ways to keep your fork in sync with this repo:
170
+
When you first create your fork, it will be an exact copy of this repository. Over time, our docs will change as they are updated, but your fork won’t automatically stay up-to-date. Here are some ways to keep your fork in sync with this repo:
Copy file name to clipboardExpand all lines: README.md
+15-42Lines changed: 15 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,75 +2,49 @@
2
2
3
3
Welcome to Solid's documentation!
4
4
5
-
This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
6
-
contains all the source code that we use to build our docs.
5
+
This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo contains all the source code that we use to build our docs.
7
6
8
-
[](https://gitpod.io/#https://github.com/solidjs/solid-docs-next)
9
-
[](https://codesandbox.io/p/github/solidjs/solid-docs-next/)
10
-
[](https://stackblitz.com/github/solidjs/solid-docs-next)
7
+
[](https://gitpod.io/#https://github.com/solidjs/solid-docs-next)[](https://codesandbox.io/p/github/solidjs/solid-docs-next/)[](https://stackblitz.com/github/solidjs/solid-docs-next)
11
8
12
9
## What is Solid?
13
10
14
-
Solid is a JavaScript framework used for building high-performance
15
-
user-interfaces. Using a reactive approach and component-based architecture, we
16
-
want to empower developers in creating efficient and scalable web applications.
11
+
Solid is a JavaScript framework used for building high-performance user-interfaces. Using a reactive approach and component-based architecture, we want to empower developers in creating efficient and scalable web applications.
17
12
18
13
## Thank you for being here!
19
14
20
-
You can help make our docs better for the community! Your feedback is welcomed.
21
-
In addition, any editing, translating, designing, and developing skills are
22
-
welcomed. We are grateful to welcome you into our community!
15
+
You can help make our docs better for the community! Your feedback is welcomed. In addition, any editing, translating, designing, and developing skills are welcomed. We are grateful to welcome you into our community!
23
16
24
-
If you want to see how you can contribute, check out our
25
-
[How You Can Help](#how-you-can-help) section.
17
+
If you want to see how you can contribute, check out our [How You Can Help](#how-you-can-help) section.
26
18
27
19
## Chat with us
28
20
29
-
You can learn more about Solid, get support, and meet other devs and
30
-
contributors in our [Discord community](https://discord.com/invite/solidjs).
21
+
You can learn more about Solid, get support, and meet other devs and contributors in our [Discord community](https://discord.com/invite/solidjs).
31
22
32
23
## Raise an issue
33
24
34
-
Have you noticed something is missing, confusing, or is wrong in our
35
-
documentation?
25
+
Have you noticed something is missing, confusing, or is wrong in our documentation?
36
26
37
-
Check to see if it has
38
-
[already been mentioned ](https://github.com/solidjs/solid-docs-next/issues)
39
-
and, if not,
40
-
[create an issue](https://github.com/solidjs/solid-docs-next/issues/new/choose)
41
-
to bring it to our attention!
27
+
Check to see if it has [already been mentioned ](https://github.com/solidjs/solid-docs-next/issues) and, if not, [create an issue](https://github.com/solidjs/solid-docs-next/issues/new/choose) to bring it to our attention!
42
28
43
29
## Share an idea
44
30
45
-
Do you think something could be better? Have an idea you feel could make the
46
-
docs better?
31
+
Do you think something could be better? Have an idea you feel could make the docs better?
47
32
48
-
Discussion threads are where you can offer feedback on things that might not be
49
-
problems that need addressing, but are ideas to be explored.
33
+
Discussion threads are where you can offer feedback on things that might not be problems that need addressing, but are ideas to be explored.
where we can brainstorm these ideas, ask questions, and share goals!
35
+
Join us in the [Discussions section](https://github.com/solidjs/solid-docs-next/discussions/280) where we can brainstorm these ideas, ask questions, and share goals!
54
36
55
37
## Suggest a fix or contribute
56
38
57
39
Have you found a typo, broken link, or another item with an obvious quick fix?
58
40
59
-
If you can see what the problem is, and you know how to fix it, you can make a
60
-
PR (pull request) with the change and contribute to the docs repo yourself.
41
+
If you can see what the problem is, and you know how to fix it, you can make a PR (pull request) with the change and contribute to the docs repo yourself.
61
42
62
-
If you're looking to make a larger contribution, please see our
If you're looking to make a larger contribution, please see our [CONTRIBUTING.md](https://github.com/solidjs/solid-docs-next/blob/main/CONTRIBUTING.md) first!
65
44
66
45
## Running the Site Locally
67
46
68
-
At the moment, we recommend running the site locally through either
[Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs-next), or
71
-
[StackBlitz](https://stackblitz.com/github/solidjs/solid-docs-next). These are
72
-
the quickest and easiest way to browse and edit the project files and run the
73
-
site locally.
47
+
At the moment, we recommend running the site locally through either [CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs-next/), [Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs-next), or [StackBlitz](https://stackblitz.com/github/solidjs/solid-docs-next). These are the quickest and easiest way to browse and edit the project files and run the site locally.
74
48
75
49
The app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v18+`.
76
50
@@ -90,7 +64,6 @@ This will start your the app at [localhost:3000](http://localhost:3000) or the n
90
64
91
65
### Collections and virtual modules
92
66
93
-
The builds an [Astro](https://docs.astro.build/en/guides/content-collections/) inspired collection navigation, it will bring all routes and generate a couple of files at `/.solid`.
94
-
These files are exposed to your app via [Vite virtual modules](https://vitejs.dev/guide/api-plugin#virtual-modules-convention). This task is perform via our `sync` script (`pnpm sync`), ran before every build.
67
+
The builds an [Astro](https://docs.astro.build/en/guides/content-collections/) inspired collection navigation, it will bring all routes and generate a couple of files at `/.solid`. These files are exposed to your app via [Vite virtual modules](https://vitejs.dev/guide/api-plugin#virtual-modules-convention). This task is perform via our `sync` script (`pnpm sync`), ran before every build.
95
68
96
69
If changes are made to the navigation (new entry, or repositioning entry), it is necessary to restart the server for changes to take effect.
0 commit comments