nodejs / nodejs/node

Render "About this documentation" as the landing page for the documentation section

未关闭
#60,667 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
122k
派生
37.4k
平均合并
4 天 2 小时
30 天内合并 PR
283

描述

URL:

https://nodejs.org/docs/latest/api/

Browser Name:

Safari

Browser Version:

26.0.1 (21622.1.22.11.15)

Operating System:

MacOS 26.0.1

How to reproduce the issue:

Upon opening the documentation page, the user sees two table of contents, one in the navigation bar and one as the landing page as shown here:

Image

I think it would be more visually consistent if the landing page were “About this documentation.” Such as this snapshot below:

Image

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先打开 https://nodejs.org/docs/latest/api/,并将当前着陆页与 issue 中所示的拟议“About this documentation”视图进行比较。追踪生成此页面的文档入口点,然后确认导航和着陆页不再呈现重复的目录。

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

评估

技术栈
javascript
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

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