carbynestack / carbynestack/carbynestack.github.io
Versioned website
- Dominant language
- HTML
- Stars
- 9
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to have our documentation versioned to go hand in hand with our Carbyne Stack SDK releases. This seems to be possible rather easily using mkdocs Material (see https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/). However, some changes in the GHA workflows would be necessary. It would probably also make sense to introduce the release process for the website as part of this.
Contributor guide
Research direction
Start by reviewing the current documentation structure and GitHub Actions workflows, then read the linked MkDocs Material versioning guidance. Define how SDK releases map to website versions and what the website release process should be; done means versioned documentation with the required workflow changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100