EdricChan03/Koogle-API

API Documentation

Offen

#3 geöffnet am 14.04.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Kotlin (0 Forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Erkunde die Dokkatoo Integration und folge den verknüpften Issues, um Build Probleme zu beheben.
Tech Stack
kotlin
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80