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

asyncapi / parser-js

AsyncAPI parser for Javascript (browser-compatible too).

Apache License 2.0

119 stars 97 forks source link

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

Closed derberg closed 5 months ago

derberg commented 1 year ago

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

github-actions[bot] commented 9 months ago

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

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 :heart: