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

continuous publishing for api-docs in agoric-sdk #1032

Closed
Tracked by #1031
dckc opened this issue Mar 25, 2024 · 4 comments
Closed
Tracked by #1031

continuous publishing for api-docs in agoric-sdk #1032

dckc opened this issue Mar 25, 2024 · 4 comments
Labels
api-docs issues that generated api-docs should address

Comments

@dckc
Copy link
Member

dckc commented Mar 25, 2024

like https://endojs.github.io/endo/ but for agoric-sdk

cloudflare pages seems to be our normal approach

@LuqiPan LuqiPan self-assigned this Mar 25, 2024
@LuqiPan LuqiPan changed the title continuous publishing for api-docs in agoric-sdk, ui-kit continuous publishing for api-docs in agoric-sdk Mar 26, 2024
@LuqiPan
Copy link
Contributor

LuqiPan commented Mar 26, 2024

Update:

I created a separate issue that captures the work to do this for ui-kit repo: #1047

@dckc dckc added the api-docs issues that generated api-docs should address label Mar 28, 2024
@dckc
Copy link
Member Author

dckc commented Apr 3, 2024

fixed in #1038

@dckc dckc closed this as completed Apr 3, 2024
@dckc
Copy link
Member Author

dckc commented Apr 12, 2024

The approach in #1038 is nice in that it results in integrated search (#927). But it brings in an extra build step during drafting. And typedoc-plugin-markdown has 2 major limitations:

I asked @sufyaankhan to reconsider this approach. Separately publishing endo, agoric-sdk (#1032) and ui-kit (#1047) seems like a lower-risk approach for the short term.

@dckc dckc reopened this Apr 12, 2024
@dckc
Copy link
Member Author

dckc commented Apr 12, 2024

Thanks to @toliaqat , we now have https://agoric-sdk.pages.dev/

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