[RL-67] Document typed .rs imports (Milestone 5) - #45
Merged
Conversation
Add a TypeScript types guide covering the ambient floor, the precise `.d.rs.ts` sidecars, and the three ways to generate them (the editor Language Service plugin, the build-time `types` option, and the `gen-types` CLI), plus the tsconfig requirements and the VS Code workspace-TypeScript step. Document the `types` option in the API reference and note typed imports in the overview and README. Refs: RL-67
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Milestone 5 of typed
.rsimports (RL-67): user docs for the whole feature.allowArbitraryExtensions+moduleResolution), and the three ways to generate the sidecars - the editor Language Service plugin (+ VS Code "Use Workspace Version"), the build-timetypesoption, and thegen-typesCLI - plus the gitignore note and the current classes-not-yet-typed limitation.typesoption in the quick-reference and global-options tables, with a pointer to the guide.Notes
Docs-only. The Docusaurus build/deploy runs on push to
main(not PRs), so the live links are verified post-merge. Closes out the documentation milestone; classes/structs typing was deferred.