microsoft / microsoft/TypeScript

Include new features in handbook instead of referencing "What's new".

Open
#36,009 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Docs
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

While reading through the handbook I find something like this:

"From TypeScript 3.7 and onwards, you can use optional chaining to simplify working with nullable types." Where "optional chaining" links to the "What's new" page for version 3.7.

Why not include this in the handbook but put references - in the handbook - to other pages explaining "What's new"?

Please include all features of the language in the handbook. Actually I'd suggest to always update the handbook and only put references in the "What's new" page with a link to the relevant pages in the handbook.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the handbook’s optional chaining entry with the linked “What’s new” page for TypeScript 3.7. Determine which language features are missing from the handbook and whether each can be explained there with references back from “What’s new.” Done means the handbook contains the relevant feature documentation and “What’s new” pages link to it.

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
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.