microsoft / microsoft/TypeScript-Website
Handbook update
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 7
Description
- Separate page for Isolated Declarations https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-5.html#isolated-declarations.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-5.html#the-configdir-template-variable-for-configuration-files to be added to 'What is tsconfig.json' page, which should be added to 'The Basics' page.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-3.html#resolution-mode-supported-in-all-module-modes should be added to 'Modules Reference' section.
- Decorators should get a new page/separate pages.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html#supporting-multiple-configuration-files-in-extends - There should a new 'quick tsconfig' page where this should be added.
-
@overloadand@importneed to be added to https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html. -
satisfiesoperator https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-9.html#the-satisfies-operator needs to be added to https://www.typescriptlang.org/docs/handbook/jsx.html#the-as-operator. - https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-7.html#instantiation-expressions should be added to 'Mor on Functions/Generic Functions' page.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-7.html#extends-constraints-on-infer-type-variables needs to be added to https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-7.html#extends-constraints-on-infer-type-variables.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-7.html#optional-variance-annotations-for-type-parameters can be explained in a few sentences and added.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-7.html#resolution-mode needs to be added to Modules Reference.
- Dependent Parameters https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-6.html#control-flow-analysis-for-dependent-parameters should be added to the Control Flow Analysis section.
- https://www.typescriptlang.org/docs/handbook/2/conditional-types.html should be added to the 'Reference' page.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html#short-circuiting-assignment-operators should be added to the 'Reference' section
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html#ts-ignore-or-ts-expect-error should be added to 'The Basics' section.
- Explain Generators in https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#handbook-content.
- Add https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-6.html#stricter-generators to the above Generators section.
- https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions needs to be added to the 'Narrowing' section.
- reverse-mapped types explanation is missing
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Handbook pages, Modules Reference, The Basics, Reference, JSX, JSDoc supported types, Iterators and Generators, and the cited release notes. Group the checklist by destination and verify each requested topic has an appropriate explanation or page. Done means every checkbox is addressed and the resulting Handbook navigation and links are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100