copper-leaf / copper-leaf/kodiak

[language support] Ruby

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
16
Forks
2
PR merge metrics
No merged PRs in 30d

Description

A Ruby documentation runner should be able to be run on JRuby so that the formatter can be written from Kotlin/JVM.

Formatter options:

- [Yard](https://yardoc.org/)
- [RDoc](https://github.com/ruby/rdoc)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing how the project wraps documentation CLI tools and how formatter options are represented. Compare Yard and RDoc as the listed Ruby options, then determine what is needed for a Ruby documentation runner on JRuby and Kotlin/JVM. Done means the runner works on JRuby and produces the project's usable JSON model.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, ruby
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.