hyperledger-identus / hyperledger-identus/docs

Multi DOC versions for Typescript SDK

Open
#103 2 comments 0 reactions 2 assignees Claimed by @amagyar-iohk View on GitHub
documentation enhancement
Dominant language
TypeScript
Stars
15
Forks
9
Avg merge
40m
Merged PRs (30d)
6

Description

# Multi doc portal

The main goal of this ticket, discussion to talk about the different approaches that we have to get multiple versions of the typescript SDK deployed each time the SDK goes out.

We need some bash scripting at least:

Knowing the tag that we are going to release, generate the documentation in the typescript repository and commit the files, then Call the Specific action in docs portal to deploy to production. This ci task starts a branch from main, pulls the TS changes, creates a Pull request + asks for Review.

There's several approaches, who will initiate the commits, the TS repository, the cloud agent?
Things to keep in mind:
Docs repo should store all versions
TS Repo should store latest
Docs repo will be in charge of programmatically creating or changing the sidebar.
During the PR, the devs can still make changes or adjustments because the CI task will just facilitate but not commit or merge anything for us.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.