EdricChan03/Koogle-API

API Documentation

Open

#3 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

There should be automatically generated API documentation to easily see what APIs are available for a particular module.

We can use Dokka for this.

Tasks

  • Add auto-generated Dokka docs with Dokkatoo
    • Verify composite builds support (adamko-dev/dokkatoo#49)
    • Investigate why KMP sources are broken (adamko-dev/dokkatoo#50)
    • Exclude test sources from Dokka docs (adamko-dev/dokkatoo#51)
  • Add CI to auto-publish docs

Contributor guide

Research direction
Explore Dokkatoo integration and follow the linked issues to resolve build problems.
Tech stack
kotlin
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80