Skip to content

API Reference Docs - Docs Revamp #1031

@sufyaankhan

Description

@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
- [x] Publish initial typedoc for endo: https://endojs.github.io/endo/
- [x] https://github.com/Agoric/documentation/issues/1064
- [ ] https://github.com/endojs/endo/pull/2181
- [ ] https://github.com/Agoric/documentation/issues/1032
- [ ] https://github.com/Agoric/documentation/issues/1047
- [ ] https://github.com/Agoric/agoric-sdk/issues/8852
- [ ] https://github.com/Agoric/agoric-sdk/issues/4291
- [ ] https://github.com/Agoric/documentation/issues/1061
- [ ] https://github.com/Agoric/documentation/issues/1060
- [ ] https://github.com/Agoric/documentation/issues/1062
- [ ] https://github.com/Agoric/documentation/issues/1063
- [ ] https://github.com/Agoric/documentation/issues/431
- [ ] https://github.com/Agoric/documentation/issues/883

Metadata

Metadata

Assignees

Labels

4day-dapp-mar1things due march 1st in the 4 day dappapi-docsissues that generated api-docs should address

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions