Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

General issues with discoverability of information

未关闭
#2,908 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
typescript

调研方向

从 https://www.typescriptlang.org/ 开始,检查网站对“assert”和“asserts”的搜索行为,然后将其与链接的 narrowing 页面中的“Assertion Functions”部分进行比较。当 issue 引用的内容(包括相关的“What's New”信息)能够通过站内搜索找到时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
TypeScript
星标
2.6k
派生
1.5k
平均合并
2 天 12 小时
30 天内合并 PR
8

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

microsoft/TypeScript-Website 的其他 Issue

查看 microsoft/TypeScript-Website 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。