charliecloud icon indicating copy to clipboard operation
charliecloud copied to clipboard

Published 20 hours ago • verified publisher icon hpc

make versioned documentation

Open MFTabriz opened this issue 3 years ago • 2 comments

As the charlicloud commands are constantly evolving, it would be nice to have versioned documentation to avoid possible confusion.

related to #836 : ReadTheDocs seems to support this.

MFTabriz avatar Jun 20 '22 11:06 MFTabriz

I agree this would be good.

While we use the Read The Docs styles, currently they are hosted on GitHub pages. Brief looking suggests we'd need to manually set up different versions.

We'd also want to be clear that only the latest version is supported.

reidpr avatar Jun 21 '22 23:06 reidpr

We can add a banner/header to the older versions of documentation to directly tell the users that only the latest version is supported.

MFTabriz avatar Jun 22 '22 14:06 MFTabriz