Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] impl typedoc #1507

Open
louis030195 opened this issue Feb 28, 2025 · 0 comments
Open

[feature] impl typedoc #1507

louis030195 opened this issue Feb 28, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@louis030195
Copy link
Collaborator

user feedback:

❌ For reference doc include auto-generated docs, like TypeDoc ( https://typedoc.org/ ) , so the return type can be investigated, etc. I found it really hard to know based on these docs what the data output looks like. And worse, when I checked the docs were outdated so the method and response structure was wrong. TypeDoc can include inline examples for each method, too. The single source of truth for these examples should be near those methods so that you can use doc generation And if ever those methods are removed or the signatures change, then docs are automatically updated. https://typedoc.org/example/index.html

@louis030195 louis030195 added the enhancement New feature or request label Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant