EdricChan03 / EdricChan03/Koogle-API

API Documentation

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement good first issue help wanted
Dominant language
Kotlin
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

# Overview

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

We can use [Dokka](https://kotlinlang.org/docs/dokka-introduction.html) for this.

## Tasks

- [ ] Add auto-generated Dokka docs with [Dokkatoo](https://github.com/adamko-dev/dokkatoo)
- [x] 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

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.