bcgov / bcgov/api-services-portal

API Getting Started Section

Open
#77 1 comment 0 reactions 0 assignees View on GitHub
enhancement refinement needed ux
Dominant language
TypeScript
Stars
27
Forks
8
Avg merge
1d 45m
Merged PRs (30d)
13

Description

Getting Started content section that should display the following bits of information:

* Overview
* Endpoints (Base URLs)
* Openapi Spec, Postman Collection
* Authentication (overview based on the Auth Flow)
* Further Reading (links to documentation)

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names the API Getting Started content but does not identify a file, route, or test. Start by locating the existing API documentation or portal entry point, then confirm how content sections are structured; the work is done when Overview, Base URLs, OpenAPI and Postman links, authentication guidance, and further-reading links are displayed.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.