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

Any reason why API docs are not generated for the library? #860

Closed
derberg opened this issue Sep 28, 2023 · 1 comment
Closed

Any reason why API docs are not generated for the library? #860

derberg opened this issue Sep 28, 2023 · 1 comment
Labels
question Further information is requested stale

Comments

@derberg
Copy link
Member

derberg commented Sep 28, 2023

For v1 we had API.md with a nice generated overview of all the API that library exposed.

Now in readme we link to Parser API but this is not really enough, and Parser API do not cover Parser JS API 100%

Would be super nice if docs are generated from sourced, with some TS tool, like maybe npx typedoc src/index.ts

@derberg derberg added the question Further information is requested label Sep 28, 2023
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Jan 27, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested stale
Projects
None yet
Development

No branches or pull requests

1 participant