Improve Devportal Search Document for Full Name Search
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Current Limitation
Currently there is no guidance on how to handle complex API names with hyphens and spaces in https://apim.docs.wso2.com/en/latest/api-developer-portal/discover-apis/search/
Suggested Improvement
Mention to use double quotes when search using name: to handle complex API names with hyphens or spaces.
Version
4.3.0, 4.4.0, 4.5.0, 4.6.0, 4.7.0, Master
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 API Developer Portal search page linked in the issue and locate the guidance for searching by name. Add a note explaining that double quotes should be used for API names containing hyphens or spaces, then verify the wording and examples render correctly in the documentation build.
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
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100