docs-hub icon indicating copy to clipboard operation
docs-hub copied to clipboard

Fix automation between TS SDK and Docs Hub

Open arboleya opened this issue 1 year ago • 2 comments

When any PR is merged to master, CI triggers a workflow on the Docs Hub repo, which creates another PR for updating such docs. This PR, when approved, triggers a deploy routine that goes, updates, and redeploys the docs.

The aim here is to remove the manual approval step so that the docs are automatically updated with the latest releases every time a new PR goes to master. Check the flowchart at the end.

Given our previous interactions with the docs, we should lead this effort with DevRel.

flowchart TB;
  SDK(SDK) --> PR
  SDK --> Release
  PR{Merged PR} --> |updates| Nightly(Nightly Docs)
  Release{New Release} --> |updates| Stable(Stable Docs)

arboleya avatar Dec 03 '24 13:12 arboleya

cc @rishabhkeshan @calldelegation

arboleya avatar Dec 03 '24 15:12 arboleya

Marking this as blocked since the devrel team is doing a rewrite of the docs-hub, so waiting on that until that happens.

linear[bot] avatar Dec 19 '24 04:12 linear[bot]