-
-
Notifications
You must be signed in to change notification settings - Fork 10.5k
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
docs(community/contributing): improvements for docs changes #12573
Conversation
|
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 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 |
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
There was a problem hiding this 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.
@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. |
7fdbcde
to
cf008a6
Compare
* 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>
… docs