[doc] Make human-readable name and one-line description required fields
Open
Component:Doc
Earlgrey-PROD Triaged
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
I guess in the future it would be nice for this to be a required field as well as the `one_line_desc` as they will impact the quality of the generated docs.
_Originally posted by @moidx in https://github.com/lowRISC/opentitan/pull/17286#discussion_r1107487751_
Depends on #17307.
Contributor guide
Research direction
Start by reviewing the related issue #17307 and tracing where the human-readable name and one_line_desc fields are defined or checked. Done means both fields are required and the generated documentation reflects their presence.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100