EdricChan03/Koogle-API

User documentation

Open

#4 opened on Apr 14, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (0 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Overview

Once we have the barebones APIs up, we should have front-facing user documentation on how to use them.

Contributor guide

Research direction
Familiarize with the existing API endpoints and write usage documentation for each.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80