Build and store docs for each version of an adaptor
@mtuchi is already working on this.
Since Nov 9, 2022.
- Dominant language
- JavaScript
- Stars
- 24
- Forks
- 41
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 12
Description
While browsing docs.openfn.org/adaptors I'd like to be able to click into a previous version of that adaptor's documentation.
Right now, I've got to go to GitHub and read the source (and inline docs) for previous versions by clicking on a tag. Could we solve this, @mtuchi and @josephjclark , by adding a "post-tag" hook on GitHub that builds docs for an adaptor each time it's tagged/released, then uploads a pre-built jsDoc.md file as a release artifact?
Then... over on the Docusaurus site, we could do some fetching and styling to grab the previous versions of the adaptor docs and make them available via some sort of version-changing picklist.
Contributor guide
No contributing guide indexed for this repository
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.
Assessment
This issue has not been assessed yet.