Thank you for helping us make this project great and being a part of the Solid community!
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.
New to contributing? Take a look at this GitHub guide to learn how to use Git and GitHub to contribute to open-source.
If you're new to Solid, we ask that you check out our Writing Guide.
There are many ways to contribute to the Solid's documentation!
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.
You can help out by leaving review comments on PRs and adding ideas in existing GitHub issues and discussions.
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!
We encourage you to:
- File an issue
- Start a discussion
- Make a PR
- Look at our existing issues
- Review existing PRs
Issues are a great way to keep track of tasks, enhancements, and bugs for our projects. They're typically the first step to making a change.
After an issue has been considered by the community, we often reach out to community members to encourage them to submit PRs based on existing issues.
We encourage larger contributions to the docs after you participate in Issues and Discussions, as unsolicited material may not fit into our existing plans.
While you're more than welcome to mention a bug that you've encountered on our Discord, we ask that you also report it as an issue!
Helpful issues generally include:
- Clear, descriptive titles
- Links to relevant pages/files
- Explanations as to why (or for whom) this is a problem
- Option: proposed solutions
- An explanation is confusing (with a reason why)
- a code example is wrong (with or without a proposed fix)
- accessibility (a11y) issues discovered
- missing content
- request for an example on how to implement a specific feature (e.g. responsive nav bar).
We use labels as a way to organize and categorize our issues. Here are some common labels that you will see:
a11y- related to anything accessibility.bug- when something isn't working.good first issue- a good place to start for newcomershelp wanted- when we are looking for assistance on an issuei18n- anything to do with internationalization and translation
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.
Feel free to start a new discussion on any topic related to our docs!
- Is a page in the right section of the docs?
- Notice the colors are too bold? Too muted?
- Is the site navigation clear and helpful?
- Any suggestions of content that you think could be helpful adding
If you've never submitted a pull request on GitHub before, check out this overview on how to open a PR.
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.
Here's how to effectively contribute via a PR:
- 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.
- Singular Focus: Each PR should address a single issue or enhancement. Want to propose a larger change? Reach out to us on Discord and let's discuss the best way forward!
- 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. - 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.
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!
Need help making a PR? Join us on Discord, we'll be more than happy to help you out!
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.
- PRs addressing an existing fix.
- Unsolicited PRs addressing typos, broken links, and other minor problems.
- Translating an entry.
Every page on 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.
After you make your changes, click Commit changes. This will automatically create a fork of the docs in your GitHub account with the changes.
Once you have committed your edits within your fork, follow the prompts to create a pull request and submit your changes for review.
Every pull request needs to be reviewed by our contributors and approved by a maintainer.
Though it is not a hard requirement, we'd deeply appreciate if you could recommend a native speaker to review your newly added translations. This ensures translations can also adhere to our review-based system for Pull Requests.
- Create a dictionary file in
src/i18n/dictionaries/{locale}/ui.ts. The name should follow our locale convention.
- language (ISO 639-1 - set 1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
- country code(optional) (ISO 3166-1 alpha-2): https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
- E.g.: Canadian French would be:
fr-ca
- Add the
importand language information to the objects in the barrel file:./src/i18n/dictionaries/index.ts. So it will be identified by the routing system, and an entry its added to the language dropdown. - Add the language to the
arrayin./scripts/collections/index.mjsso internal files are created. - Add the important UI translations to
./src/i18n/dictionaries/{locale}/ui.ts - Add at least the index page
./src/routes/{locale}/index.mdx, so others and yourself could see things in action.
To translate a new entry to an existing language, go to src/routes/{locale} and add the entry following the exact same structure as the default.
Note
We can't accept half translated entries because there is not a way of tracking if an entry is not fully translated. Please, make sure you have the time to do the whole entry in your PR.
Once you have made your changes using your preferred method, you're ready to create a 'pull request'.
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.
Read more about making a pull request in GitHub's docs.
Please include a clear title. The description will have some pre-filled questions that we would like you to answer.
Every pull request generates a preview of the site, including your proposed changes, using Netlify for anyone to see.
Use the Deploy Preview link in your pull request to review and share your changes.
The docs site will be automatically updated whenever pull requests are merged.
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.
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.
To create your copy, click the Fork button at the top right of any page in this repository.
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:
- Navigate to your fork on GitHub
- Click
Sync forkand thenUpdate branch
In the terminal on your computer:
- Make sure you're on the main branch and then run
git checkout main - Fetch and merge the updates:
git pull upstream main - Push the updates back to your fork on GitHub:
git push origin main
- Go to the "pull" GitHub app page
- Click
Install - Follow the instructions to select