Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 38 forks source link

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

Closed dckc closed 2 months ago

dckc commented 3 months ago

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

cloudflare pages seems to be our normal approach

LuqiPan commented 3 months ago

Update:

I created a separate issue that captures the work to do this for ui-kit repo: https://github.com/Agoric/documentation/issues/1047

dckc commented 3 months ago

fixed in #1038

dckc commented 2 months ago

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 commented 2 months ago

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