diff --git a/docs/dev/code.md b/docs/dev/code.md index 1e9d295725..3ca393c8f7 100644 --- a/docs/dev/code.md +++ b/docs/dev/code.md @@ -9,6 +9,7 @@ 5. {ref}`Make sure all tests are passing ` 6. {ref}`Build and visually check any changed documentation ` 7. {ref}`Open a PR back to the main repository ` +8. {ref}`Add a release note to your PR ` ## Code style diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index d9c3f6e034..dcad9533ed 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -12,10 +12,12 @@ Sometimes these caches are not invalidated when you've updated the docs. If docs are not updating the way you expect, first try "force reloading" your browser page – e.g. reload the page without using the cache. Next, if problems persist, clear the sphinx cache (`hatch run docs:clean`) and try building them again. +(adding-to-the-docs)= + ## Adding to the docs For any user-visible changes, please make sure a note has been added to the release notes using [`hatch run towncrier:create`][towncrier create]. -We recommend waiting on this until your PR is close to done since this can often causes merge conflicts. +When asked for “Issue number (`+` if none)”, enter the *PR number* instead. Once you've added a new function to the documentation, you'll need to make sure there is a link somewhere in the documentation site pointing to it. This should be added to `docs/api.md` under a relevant heading.