Skip to content

Commit c19b773

Browse files
melissawmjni
andauthored
Add note about unversioned pages machinery to contributing guide (#421)
# References and relevant issues Depends on napari/napari.github.io#402 # Description Adds a note to the "documentation and website deployment" section of the contributing guide about how the unversioned pages are managed. Co-authored-by: Juan Nunez-Iglesias <jni@fastmail.com>
1 parent b6b61df commit c19b773

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/developers/contributing/documentation/docs_deployment.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ through several CI workflows detailed below.
5454
`gh-pages` branch. Auto-deploys to `gh-pages` on every commit (which in
5555
turn happens on every commit to the `main` branches of either
5656
`napari/napari` or `napari/docs`).
57+
- For every commit to the `gh-pages` branch of this repo, the
58+
[`unversioned_pages.yml` action](https://github.com/napari/napari.github.io/blob/main/.github/workflows/unversioned_pages.yml)
59+
is triggered and copies the latest contents of the index page and the dev
60+
folder over the "stable" version of the documentation. This ensures that
61+
both the landing page of the website and the developer documentation,
62+
including the contributing guide, are always up to date.
5763

5864
## Notes
5965

0 commit comments

Comments
 (0)