TopoToolbox / TopoToolbox/libtopotoolbox
Attach documentation to particular code releases
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 2
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Now that we have a kind of release procedure set up, I would like to make sure that users can access the version of the documentation corresponding to the version of libtopotoolbox that they have. At the very least, I would like to deploy a latest or dev version corresponding to the current state of the repository and a stable version with the documentation of the most recent weekly release. This also provides some mechanism for testing and evaluating documentation on the latest version before it gets released. Public links to the documentation should go to the stable version.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's existing release procedure and how its documentation is currently published. Define how documentation for the current repository state and most recent weekly release will be exposed as latest/dev and stable versions. Done means public documentation links target stable while the latest version remains available for pre-release evaluation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100