search

Agoric / documentation

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

API signatures should only appear in auto-generated API DOCS #1213

Open amessbee opened 1 week ago

amessbee commented 1 week ago

Engineering raised the concern that orchestration function signatures should not be manually added to the documentation. This results in extra effort to maintain them as future changes in API signatures won't be directly reflected in documentation. Rather, these should only appear in API docs generated by TypeDoc.

Refs:

amessbee commented 1 week ago

@mujahidkay can you please add ref to discussion regarding scheduled update of API docs.