API Reference Docs - Docs Revamp

[sufyaankhan]

• The developer API product and only the developer API product needs to be documented to fulfill this rock. This requires:
  • The product owners (PM) to definitively determine what portions of the codebase are part of the developer API product & what is the rest of the platform.
  • Reference docs must be auto-generated for the entire developer API product.
  • Code examples for all portions of the developer API product must be linked from the relevant sections of the docs site. Code examples can be a mix of inline examples on the docs site, links to relevant lines of contracts or sample dapps.

Tasks

Beta Give feedback

1. Publish initial typedoc for endo: https://endojs.github.io/endo/
2. which APIs in the initial endo typedoc are _not_ part of the developer API product? #1064
   +0
3. docs: demote some packages from developer API product endojs/endo#2181
   +0
4. continuous publishing for api-docs in agoric-sdk #1032
   api-docs +1
5. continuous publishing for api-docs in ui-kit #1047
   api-docs +1
   
6. reference docs for network Port API agoric-sdk#8852
   documentation enhancement needs-design +3
   
7. Sync Zoe JSDoc with API docs agoric-sdk#4291
   ERTP Zoe audit-zestival devex documentation +5
   
8. Gap analysis: hover over APIs in dapp-offer-up and ensure the result is OK #1061
   +0
   
9. Gap analysis: likewise for dapp-agoric-basics #1060
   +0
   
10. which APIs in the initial agoric-sdk typedoc are _not_ part of the developer API product? #1062
    +0
11. which APIs in the initial ui-kit typedoc are _not_ part of the developer API product? #1063
    +0
12. Add E.get(x) documentation #431
    api-docs documentation +2
    

    
13. Documentation of parameters is ugly and inconsistent #883
    api-docs +1

[dckc]

tasks that come to mind:

• Publish initial typedoc for endo: https://endojs.github.io/endo/
• Publish initial typedoc for agoric-sdk
  • choose URL
  • continuous deployment
• Publish initial typedoc for ui-kit
  • choose URL
  • continuous deployment
• Gap analysis: what does dapp-offer-up use that we don’t have acceptable reference doc for?
  For example: is reference doc for E acceptable?
• Gap analysis: what does dapp-agoric-basics use that we don’t have acceptable reference doc for?
• which APIs in the initial typedoc are not part of the developer API product?
  • endo
  • agoric-sdk
  • ui-kit
• integrate API Doc (reference) with agoric-sdk api-doc #319
• reference docs for network Port API agoric-sdk#8852

[dckc]

stretch goal:

• include endo, agoric-sdk reference doc in search #927