microsoft / microsoft/TypeScript-Website

General issues with discoverability of information

Open
#2,908 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2.6k
Forks
1.5k
Avg merge
2d 2h
Merged PRs (30d)
7

Description

Page URL: https://www.typescriptlang.org/

Issue: The website search does not include any "What's New" sections.

Yes, this could result in outdated or duplicate content in search, however, there is currently no way to find any important features that aren't listed elsewhere. Searching for "assert" or even "asserts" does not bring up any information about the "asserts" keyword. Even searching for "assertion does not find this section https://www.typescriptlang.org/docs/handbook/2/narrowing.html#assertion-functions here. So perhaps there are just bugs with searching in general? I'm not really sure.

A more long term solution would be to provide a community editable wiki, something akin to cppreference, tsreference dot com if you will. You might be uncomfortable with not having direct authority over all the edits made, but I believe it would be an improvement on the status quo. If you're not willing to hire dedicated maintainers for the official site, then you might as well provide a platform for others to do the job for you. You can't have your cake and eat it too unfortunately.

This would lift a lot of the burden of writing the handbook as well. It wouldn't be so crippling to be missing newer information from it when there's always a bleeding edge reference that one can look to. The handbook's purpose gets freed up as a beginner resource instead of a catch-all resource. Microsoft can be satisfied they are only publishing approved ideas of the language, the TS team doesn't have as much pressure from the community to focus on it, and new information is still more accessible than it was before.

Contributor guide

No contributing guide indexed for this repository

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 at https://www.typescriptlang.org/ and inspect the website search behavior for “assert” and “asserts,” then compare it with the linked narrowing page’s “Assertion Functions” section. Done means the issue’s referenced content, including relevant “What’s New” information, is discoverable through the site search.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.