Skip to content

Do not generate doc from definition file #2057

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

Open
jdeniau opened this issue Feb 23, 2025 · 0 comments · May be fixed by #2104
Open

Do not generate doc from definition file #2057

jdeniau opened this issue Feb 23, 2025 · 0 comments · May be fixed by #2104
Milestone

Comments

@jdeniau
Copy link
Member

jdeniau commented Feb 23, 2025

As the definition file becomes more complicated to handle all TS strictness, generating the documentation from it make the documentation less friendly for users.

Moreover, if we generate the definition file from the code directly, generating the documentation from it won't be an option.

Let's move to a plain documentation in markdown, mdx or plain html to make the doc more DX friendly.

@jdeniau jdeniau added this to the 6.0 milestone Feb 23, 2025
@jdeniau jdeniau linked a pull request May 10, 2025 that will close this issue
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