Giters

Open-Cap-Table-Coalition / Open-Cap-Format-OCF

Open Cap Format (OCF) - The Open Source Company Capitalization Data Standard. OCF can be used to structure and track the complex data structures necessary to build and maintain accurate capitalization (cap) tables.

Home Page:https://opencaptablecoalition.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Enhancement]: Look Into Versioning Our Documentation in MkDocs

JSv4 opened this issue · comments

commented

Description of Enhancement :

Our current doc pipeline just publishes the most recent version of the documentation. We should create a script as part of our release scripts to release versioned docs.

Why is this Needed?

Developer-friendly docs

Anything else we need to know?

commented

@pjohnmeyer I am wondering how should we trigger the deployment of the documentation once a release is created. Currently we have branch for release-v1.1.0 and a tag v1.1.0. Any suggestion which one is better to use as a trigger for the documentation versioning deployment?

commented

@xudiera the branch is made first in order to run the various tools and update the versions, etc., and make a commit. The tag is added to the commit with the necessary URL and id changes, so the tag should probably be the trigger.