Skip to content

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

@amessbee

Description

@amessbee

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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    api-docsissues that generated api-docs should addressdocumentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions