123ishaTest / 123ishaTest/igt-docs

Headline "Requirements" aren't requirements, but features

未关闭 适合新手
#2 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
5
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

I was confused reading the docs where the subheadline of feature pages say "Requirements" but the list under it is a list of use cases, not requirements. Since `Feature` is already a class name in the tool (and so is `Requirements` for that matter), what about changing this headline to "Purpose" or "Benefits", "Advantages", "Properties", "Traits", etc. or something like that?

Example:

image

贡献指南

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

调研方向

Look at the documentation pages for features in the project, likely in the docs/ directory. Find where the 'Requirements' headline is used and change it to a more accurate term like 'Purpose' or 'Benefits'. Verify the change by checking the rendered documentation locally or in a preview.

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

评估

领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
85/100

把新 issue 发到你的邮箱

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