Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI/CD to ensure endo, agoric-sdk references in docs site is up-to-date and error-free #1046

Open
4 tasks
LuqiPan opened this issue Mar 26, 2024 · 0 comments
Open
4 tasks
Labels
api-docs issues that generated api-docs should address

Comments

@LuqiPan
Copy link
Contributor

LuqiPan commented Mar 26, 2024

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
@dckc dckc added the api-docs issues that generated api-docs should address label Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-docs issues that generated api-docs should address
Projects
None yet
Development

No branches or pull requests

2 participants