EdricChan03/Koogle-API

API Documentation

Ouverte

#3 ouverte le 14 avr. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Kotlin (0 fork)auto 404
documentationenhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (1 étoile)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Explorez l'intégration de Dokkatoo et suivez les problèmes liés pour résoudre les problèmes de construction.
Stack technique
kotlin
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80