Skip to content

Commit

Permalink
Docs: Add section about using link in documentation (#13422)
Browse files Browse the repository at this point in the history
  • Loading branch information
gziolo authored and mkaz committed Jan 22, 2019
1 parent af9ea75 commit 0628573
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,20 @@ Documentation is automatically synced from master to the [Gutenberg Documentatio

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).

### Using links

It's very likely that at some point you will want to link to other documentation pages. It's worth emphasizing that all documents can be browsed in different contexts:
- Gutenberg Handbook
- GitHub website
- npm website

That's why it's recommended to use absolute links without the `https://github.com/WordPress/gutenberg` part for all files which match the following patterns:
- `/docs/*.md`
- `/packages/*/README.md`
- `/packages/components/src/**/README.md`

This way they will be properly handled in all three aforementioned contexts.

### `@wordpress/component`

If you're contributing to the documentation of any component from the `@wordpress/component` package, take a look at its [guidelines for contributing](/packages/components/CONTRIBUTING.md).
Expand Down

0 comments on commit 0628573

Please sign in to comment.