bluerobotics / bluerobotics/ardusub-gitbook
Unify docs for each software
Open
enhancement
- Dominant language
- Python
- Stars
- 26
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
I think the installation docs should instead be part of their respective main pages, and the Summary page can just link straight to that heading within the main page. At the moment our main pages for each software don't specify how to install, which is awkward from a UX perspective.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Summary page and each software's main page, then locate the current installation sections. Done means installation guidance is present under the relevant main-page headings and the Summary page links directly to those headings for every software.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100