napari / napari.github.io

website for the napari image viewer
https://napari.org/
44 stars 43 forks source link

Folder structure for versioned API docs #350

Closed melissawm closed 2 years ago

melissawm commented 2 years ago

This is the first part of adding the versioned docs for napari. The other half is fixing the deployment of the docs from the main site to this branch through github actions (PR here: https://github.com/napari/napari/pull/4635)

To see how this looks, you can check for example the release notes:

If you prefer waiting to see the napari/napari github actions PR before merging this one, that would probably be best.

As a note, the github action to be added to napari/napari will deploy any fresh documentation PRs to the dev folder, not touching or deleting any other folders in this setup. But this means these two PRs will need to be merged in tandem so the gh-pages branch doesn't get overwritten in the meantime.


Details

Despite the huge list of changed files, they were only moved. This also means the conflicts that are showing up here are irrelevant, as they are merely showing the files that were moved and not any actual changes to content.

Note that this PR is not against main, but against the gh-pages branch.

codemonkey800 commented 2 years ago

awesome! yeah we should probably wait for the GitHub action part since this PR is already running into a bunch of conflicts

jni commented 2 years ago

@melissawm Apologies I missed this the first time around! As discussed in docs working group meeting, could you update the PR, then add a more detailed description of the changes here, since the "files changed" tab is useless? 😂 Thank you!

melissawm commented 2 years ago

Ok @jni - I believe this is ready to go!