gren-lang / gren-lang/compiler
Add documentation command
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 503
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
Currently there is no built in way to see documentation for types, modules, or functions.
A command like: gren doc <type|function|module> which shows the documentation for that type|function|module would be greatly helpful.
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
Start by reviewing the compiler's existing command-line entry points and how documentation for types, modules, and functions is represented. Define the scope and behavior of gren doc <type|function|module>, then verify that each supported target displays its documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100