You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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:
The text was updated successfully, but these errors were encountered: