Improve readability in framework documentation
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 68
- Forks
- 82
- PR merge metrics
- No merged PRs in 30d
Description
I've been looking forward to step up in my racket journey and start making more complex programs, yet I've been deter from using (most parts of) the framework module because of what appears to be a bug or bad configuration (or most likely a scribblings limitation) in the doc generation.
you can (not) see where a class (or interface) ends and where other starts, and since many method names are repeated it gets confusing to search, since everything is flat.
I would like to help, but I wouldn't really now how, I open this issue in hope that this could make the library easier to use.
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 examining the framework module's generated documentation and its Scribblings configuration, using the linked screenshot as context. Determine how class or interface boundaries and repeated method names should be distinguished; done when the generated documentation clearly separates each type and remains easy to search.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100