Skip to content

Doc as mdx instead of export from .d.ts file #2104

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

Merged
merged 32 commits into from
May 23, 2025
Merged

Doc as mdx instead of export from .d.ts file #2104

merged 32 commits into from
May 23, 2025

Conversation

jdeniau
Copy link
Member

@jdeniau jdeniau commented May 5, 2025

Fixes #2057

  • types is getting harder to understand, and doc is not readable
  • repl.it is closed
  • doc is too hard to edit, and not really moving
  • doc in editor (vscode hover for example) is too complex for an editor

This PR does extract all doc from the immutable.d.ts file to a specific page for each interface.

We should add #1756 after that.

@jdeniau jdeniau marked this pull request as ready for review May 23, 2025 21:47
@jdeniau jdeniau merged commit 21de701 into main May 23, 2025
5 checks passed
@jdeniau jdeniau deleted the doc-mdx branch May 23, 2025 21:47
@jdeniau jdeniau mentioned this pull request May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Do not generate doc from definition file
1 participant