Skip to content

Commit ce400d4

Browse files
CONTRIBUTING.md updates (WIP) (#1583)
* Upload PDF style guide in the documentation repo * Update CONTRIBUTING file to link style guide * Update CONTRIBUTING.md --------- Co-authored-by: Pierre Wizla <[email protected]>
1 parent b7ddee2 commit ce400d4

File tree

2 files changed

+1
-3
lines changed

2 files changed

+1
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,7 @@ You are now ready to contribute to the Strapi documentation! 🚀
9696

9797
### Write technical documentation
9898

99-
The Strapi documentation follows the [Google Style Guide](https://developers.google.com/style). The [Highlights](https://developers.google.com/style/highlights) section provides information on tone, structure, and formatting.
100-
101-
_Formatting guidelines and a syntax guide to both built-in and custom Docusaurus features will be published soon. In the meantime you can look at the official [Docusaurus.io documentation](https://docusaurus.io/docs/) and explore our [custom modifications in the code base](https://github.com/strapi/documentation/tree/main/docusaurus/src)._
99+
The Strapi documentation follows the [Strapi formatting & style guide](STYLE_GUIDE.pdf) (also available on [Notion](https://handbook.strapi.io/user-success-manual/strapi-documentation-style-guide)). Feel free to also take a look at the [Google Style Guide](https://developers.google.com/style) and especially the [Highlights](https://developers.google.com/style/highlights) section for more information on technical writing tone, structure, and formatting.
102100

103101
When you are finished writing, create a pull request from your forked repository to the original `documentation` repository (see [the GitHub docs](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for more information) or use the _Create a new branch for this commit and start a pull request_ option if you are using the GitHub web browser interface (see [the GitHub docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
104102

STYLE_GUIDE.pdf

1020 KB
Binary file not shown.

0 commit comments

Comments
 (0)