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

Generate api reference from library source code #708

Open
moklick opened this issue Mar 17, 2025 · 0 comments · May be fixed by #716
Open

Generate api reference from library source code #708

moklick opened this issue Mar 17, 2025 · 0 comments · May be fixed by #716

Comments

@moklick
Copy link
Member

moklick commented Mar 17, 2025

Currently we have two sources of truth for our documentation: 1. the docs 2. the TS Doc annotations in the source code. The annotations are not used at the moment. This leads to a lot of manual work whenever something changes, outdated docs and some pages like this https://reactflow.dev/api-reference/types/node are missing a lot of important information.

It would be great if we could come up with a solution for generating the api reference from the source code annotations. For a first version I could imagine to have a script that clones the xyflow repo, analyzes the code and writes the mdx files. This task would also be super helpful for supporting versions for the api references.


Tools that could be interesting for this:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant