123ishaTest / 123ishaTest/igt-docs
Headline "Requirements" aren't requirements, but features
- Dominant language
- JavaScript
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
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:
Contributor guide
No contributing guide indexed for this repository
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100