Doc Feedback: Unclear about the SI Tooling usage in the doc
Open
Nobody has claimed this yet.
API-M-4.0.0
Docs/TW
Priority/High
Type/Improvement
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Step 3 , Step 4 uses SI Tooling. But in this doc we haven't mention about we need to use SI Tooling.
Hence. Step 4 is confusing.
Better to add detailed steps may be with supporting images.
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
Open the documented page at the provided URL and compare Step 3 with Step 4, focusing on where SI Tooling is assumed but not introduced. Done means the prerequisite use of SI Tooling and the Step 4 procedure are explained clearly, with supporting images if needed.
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
- 55/100