Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(community/contributing): improvements for docs changes #12573

Conversation

thomasgauvin
Copy link
Contributor

… docs

Copy link

changeset-bot bot commented Dec 17, 2024

⚠️ No Changeset found

Latest commit: cf008a6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Dec 17, 2024

Hi @thomasgauvin,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Dec 17, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@timdorr timdorr changed the title thomasgauvin: add documentation on how to contribute to the developer… add documentation on how to contribute to the developer… Dec 18, 2024
Copy link
Contributor

@brookslybrand brookslybrand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for helping out here. I'm probably going to reword this a bit and just point to the docs for react-router-website (after improving them). I want to avoid having instructions in here about another repo, and just make it clear that if you want to view changes to the docs you do that over there.

@brookslybrand brookslybrand changed the title add documentation on how to contribute to the developer… docs: improve contributing guide on how to contribute to docs Dec 18, 2024
@brookslybrand
Copy link
Contributor

@thomasgauvin I simplified this a good bit since I put most of the instructions in this PR.

To contribute to the docs you don't need to install anything in this repo, plus those instructions are elsewhere in this doc, so I removed all of that.

Additionally, the typedoc stuff isn't something contributors need to worry about. We haven't automated it yet, but we plan to, in which case the API docs will automatically update.

@MichaelDeBoey MichaelDeBoey changed the title docs: improve contributing guide on how to contribute to docs docs(community/contributing): improvements for docs changes Dec 18, 2024
@brookslybrand brookslybrand changed the base branch from dev to main December 18, 2024 20:38
@brookslybrand brookslybrand force-pushed the thomasgauvin-update-contribution-guide-to-feature-react-router-website-devdocs branch from 7fdbcde to cf008a6 Compare December 18, 2024 20:42
@brookslybrand brookslybrand merged commit 27c93cb into remix-run:main Dec 18, 2024
3 checks passed
timdorr pushed a commit that referenced this pull request Dec 21, 2024
* thomasgauvin: add documentation on how to contribute to the developer docs

* Update contributors.yml

* Simplify docs contributing instructions

---------

Co-authored-by: Brooks Lybrand <brookslybrand@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants