diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ca5bd072..6f1598cf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,6 @@ ## Checklist before you pull: +- [ ] Double-check that any changes fit the [Embrace Docs Style Guide](https://www.notion.so/embraceio/Embrace-Public-Docs-Style-Guide-19f7e3c99852804abd7deacc2b14cc14). - [ ] Please ensure that there is no customer-identifying information in text or images. - [ ] Please ensure there is no consumer PII in text or images. - [ ] If you renamed any pages then perhaps you likely want to add a redirect from old to new URL so that we don't end up with broken links. You can do this by adding a pair of to/from values in `docusaurus.config.js` under `@docusaurus/plugin-client-redirects` diff --git a/README.md b/README.md index 45495ee2..f77575c2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ## Updating These Docs -You can make edits to these docs from within GitHub UI or by forking/cloning the repo to make edits locally. +You can make edits to these docs from within GitHub UI or by forking/cloning the repo to make edits locally. Ensure that any edits conform to the [Embrace Docs Style Guide](https://www.notion.so/embraceio/Embrace-Public-Docs-Style-Guide-19f7e3c99852804abd7deacc2b14cc14). ### Recommendations