EdricChan03/Koogle-API

API Documentation

Aperta

#3 aperta il 14 apr 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Kotlin (0 fork)auto 404
documentationenhancementgood first issuehelp wanted

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora l'integrazione di Dokkatoo e segui i problemi collegati per risolvere i problemi di build.
Tech stack
kotlin
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80