Emit Docs as Markdown
Open
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 4.4k
- Forks
- 627
- Avg merge
- 3d 15m
- Merged PRs (30d)
- 20
Description
Dokka does this for Kotlin and it turns out quite well when combined with Mkdocs.
https://square.github.io/kotlinpoet/1.x/kotlinpoet/com.squareup.kotlinpoet/
If we could emit docs for protos, that’d be rad!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names Dokka, KotlinPoet's generated documentation, and MkDocs, but no Wire files, tests, or entry point. Start by locating the existing proto documentation or code-generation path and compare its output with the linked KotlinPoet example. Done means protos can emit usable Markdown documentation for MkDocs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100