Add macOS-Specific Instructions to Documentation for Consistency
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description:
Some documentation pages lack macOS-specific instructions. While Linux instructions can often be followed on macOS, providing explicit macOS-specific instructions will ensure consistency and clarity in the documentation.
Examples include:
- https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/
- https://apim.docs.wso2.com/en/latest/get-started/streaming-quick-start-guide/
Suggested Labels:
type/docs
Affected Product Version:
4.3.0
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
Start with the API Manager Quick Start Guide and Streaming Quick Start Guide pages linked in the issue, comparing their existing Linux instructions with the macOS workflow. Update both pages with explicit macOS-specific instructions and verify that the documentation is consistent and complete for macOS users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100