-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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: Move packages section out of CONTRIBUTING.md #13418
Conversation
@@ -244,15 +124,15 @@ If you'd like to contribute to the design or front-end, feel free to contribute | |||
|
|||
Documentation is automatically synced from master to the [Gutenberg Documentation Website](https://wordpress.org/gutenberg/handbook/) every 15 minutes. | |||
|
|||
To add a new documentation page, you'll have to create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [root-manifest.json](https://github.com/WordPress/gutenberg/blob/master/docs/root-manifest.json). | |||
To add a new documentation page, you'll have to create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [toc.json](/docs/toc.json). |
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.
Is it toc.json
now? It has changed and I tried to figure out based on the tool which generated the manifest file.
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.
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.
You are right it is toc.json, the manifest is now generated.
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.
LGTM 👍
This split will make it easy for people to refer the contribution docs
❤️
This looks good, I have a PR that changes up the contributors handbook here: #13352 but I only modified this document a little. Go ahead and land this one and I can rebase and update. |
* Docs: Move packages section out of CONTRIBUTING.md * Update precommit hook to look at new toc.json file
* Docs: Move packages section out of CONTRIBUTING.md * Update precommit hook to look at new toc.json file
Description
CONTRIBUTING.md
has become quite big. This PR extracts the part about managing packages to its own file to make the guidelines more focused on the onboarding experience.I also update internal links to follow the same patterns we started to apply recently.