separate repo for documentation of different versions

nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents

https://manual.nexusformat.org/

Other

26 stars 57 forks source link

separate repo for documentation of different versions #1434

Open sanbrock opened 1 week ago

sanbrock commented 1 week ago

Currently, no documentation for older releases are available. They could be made available as they can be referenced.

prjemian commented 1 week ago

Legacy docs are bundled up and stored in this repository as agreed previously.

Until we initiate the publishing of versioned documentation, I suggest we continue with the previous agreement. Once we start versioned documentation, we can choose how to handle older docs that do not include version links. Such as point to the repo for legacy content.

prjemian commented 5 days ago

Python, for example, provides a drop-down menu to select other versions of its documentation:

phyy-nx commented 5 days ago

Goals:

Versioned, published, html docs, including the latest, unreleased docs
Reduce repo size by moving pdfs in legacy_docs to zenodo. Could involve a gulp force push

Action items:

How many old releases can we actually build? @PeterC-DLS
How to set up the docs with a version dropdown? @tacaswell

phyy-nx commented 5 days ago

FYI theme selected in #1472 might impact the version dropdown