Description
With the introduction of #1038 and as we work towards #927, we enter a world where the build and publication of docs.agoric.com depends on both Agoric/agoric-sdk and endojs/endo repos.
Once #1038 is complete, we'll have Agoric/documentation pulling from and building reference docs for both Agoric/agoric-sdk and endojs/endo repos whenever PRs are open or merged into Agoric/documentation repo.
However, docs site won't update when changes are made to Agoric/agoric-sdk and endojs/endo repos, nor will doc errors surface when we run yarn typedoc-markdown
in Agoric/agoric-sdk or endojs/endo repo. Instead, we'd need to checkout both repos, then convert the .md
files, generated by yarn typedoc-markdown
, to html, css, etc using vitepress in Agoric/documentation repo in order to find errors and deploy to docs site. Below is a list of tasks to close this gap.
Trigger | Repo | Goal | Issue |
---|---|---|---|
Open a PR | Agoric/agoric-sdk | Verify docs site still builds | #1044 |
Merge a PR | Agoric/agoric-sdk | Deploy to docs site with new changes | #1042 |
Open a PR | endojs/endo | Verify docs site still builds | #1045 |
Merge a PR | endojs/endo | Deploy to docs site with new changes | #1043 |
### Tasks
- [ ] https://github.com/Agoric/documentation/issues/1042
- [ ] https://github.com/Agoric/documentation/issues/1043
- [ ] https://github.com/Agoric/documentation/issues/1044
- [ ] https://github.com/Agoric/documentation/issues/1045