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

Integrate genType as 'TypeScript Interop' chapter into main docs #752

Conversation

fhammerschmidt
Copy link
Member

@fhammerschmidt fhammerschmidt commented Nov 14, 2023

Closes #746

@ryyppy
Copy link
Member

ryyppy commented Nov 22, 2023

A few things I'd change now that we have the chance to make structural changes to the genType docs:

  1. GenType is now a builtin tool, and we should not treat this section as if it would still be a library. Maybe the Introduction should rather be something like "ReScript & TS" which would briefly mention the general concepts and philosophy, plus the setup instructions (instead of having the "Getting started" page)
  2. The general sidebar structure of genType doesn't make much sense anymore (and I regretted building it this way back then). Ideally, we'd provide more concrete sidebar items that users would be looking for when interoping with TS (as we do with "JavaScript interop". The "Usage" page for instance already has a good starting point (although some items sound a little abstract), maybe it would make sense to experiment here to branch out in different documents instead.
  • image
  1. Same feeling for supported types as in the previous point... one could provide separate sidebar items for "Bind to TS primitive values", "Bind to TS objects", "Bind variants to TS", etc with proper examples (from/to mappings) to make it copy-pastable and easy to understand.

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 this pull request may close these issues.

2 participants