Tracker for improvements in models doc.
Open
Nobody has claimed this yet.
c: documentation
s: keep open
- Dominant language
- C++
- Stars
- 44
- Forks
- 40
- PR merge metrics
- No merged PRs in 30d
Description
Following are some of the things i would work on:
- Trying to move the indexing on the left as side pane or something.
- Avoiding full path names, it print jenkins/docs and all of that as file path.
- take a look at fixed-width fonts.
- Maybe swap the theme for a more subtle one.
Feel free to point more things if you notice any and here is the docs link if someone missed it.
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 at the models documentation site linked in the issue and review its current navigation, displayed paths, fonts, and theme against the four checklist items. No files or tests are named; completion means agreeing on scope and implementing and verifying the selected documentation presentation improvements.
Written by the indexing model from the issue text.
Assessment
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100