bcgov / bcgov/api-services-portal
Improve UX of the Product Details Page
- Dominant language
- TypeScript
- Stars
- 27
- Forks
- 8
- Avg merge
- 1d 45m
- Merged PRs (30d)
- 13
Description
**Context**
Location Services (LOC) team was sharing some feature requests with me, and they mentioned they were experiencing issues with clients interacting with this page.
This page is kind of unique in the API directory. It is one of the few that have public AND private endpoints on the same page.
https://api.gov.bc.ca/devportal/api-directory/273?preview=false
_I can't upload a screenshot for some reason??? Message me for the image_
Clients are directed to this page, most of them want the free, public, endpoint.
LOC has started providing instructions to click the top link / title of the API to get to the public endpoint, and NOT click "request access". They must be doing that because it is the big call to action on the page. it is not clear how to get to the public endpoint.
**Definition of Done**
* Reevaluate the UX of this page, propose improvements
* For Nathalia: Understand this page, and when/why a client would have different endpoints available on it
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Product Details page at the linked API directory URL and review how public and private endpoints, the page title, and the “request access” action are presented. Compare the current flow with the stated client confusion and document proposed UX improvements plus when different endpoints appear; done means the page behavior and recommendations are clearly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nextjs, react, typescript
- Domain
- api, design, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100