Add step numbers with (-) to headings in SI docs
Open
Nobody has claimed this yet.
API-M-4.0.0
Docs/TW
Priority/Low
Type/Improvement
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
To be consistent with API-M documentation, the following updates are required in the SI docs:
Sequential topics should carry step numbers
A dash should be used with the step number instead of the colon
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the SI documentation and compare its headings with the API-M documentation for the stated convention. Update sequential topics to use step numbers with a dash instead of a colon, then verify the SI headings consistently follow that format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100