integrate API Doc (reference) with agoric-sdk api-doc

[katelynsills]

a possible plan:

• choose domain name
  • note: the precendent used by endo is complicated by papers.agoric.com
• publish docs there (continuously, on each change)
• reconcile with API content here
• integrate with search (see also include endo, agoric-sdk reference doc in search #927)

earlier:

It appears that our types in agoric-sdk will cause jsDoc to error. For instance:

ERROR: Unable to parse a tag's type expression for source file /Users/katesills/code/agoric-sdk/packages/zoe/src/contractFacet/types.js in line 4 with tag title "property" and text "{(keyword: Keyword) => void} assertUniqueKeyword - check
whether a keyword is valid and unique and could be added in
`saveIssuer`": Invalid type expression "(keyword: Keyword) => void": Expected "$", "'", ".", "0", "@", "\"", "\\", "_", "break", "case", "catch", "class", "const", "continue", "debugger", "default", "delete", "do", "else", "enum", "export", "extends", "finally", "for", "function", "if", "implements", "import", "in", "instanceof", "interface", "let", "new", "package", "private", "protected", "public", "return", "static", "super", "switch", "this", "throw", "try", "typeof", "var", "void", "while", "with", "yield", Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode titlecase letter, Unicode uppercase letter, or [1-9] but " " found.

TypeDoc does not error and seems the most promising. It produces documentation like this:

It seems like it will take some configuration changes to make it usable. Then there is the challenge of reconciling it with our current site.

[dckc]

JSDoc errors were addressed a of:

• generate HTML documentation from TS/JSDoc agoric-sdk#8343

So we've done the exploration. I'm re-scoping this to integrate the docs site with the generated api-doc.

[sufyaankhan]

Dupe of #927

[dckc]

fixed in #1038