EdricChan03/Koogle-API

API Documentation

Aberta

#3 aberto em 14 de abr. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Kotlin (0 fork)auto 404
documentationenhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Explore a integração do Dokkatoo e siga os problemas vinculados para resolver problemas de build.
Pilha de tecnologia
kotlin
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80