Improve the documentation
Open
help wanted
kind/enhancement
- Dominant language
- Rust
- Stars
- 16.2k
- Forks
- 510
- PR merge metrics
- No merged PRs in 30d
Description
It would be great to have a FAQ or a Known Issues section into the README. The possible content would be:
- [ ] The terminal related bugs with the icons (#118).
- [ ] How to configure properly the terminal font (#117)
- [x] Some documentation about the default configuration (#113)
- [ ] The snap without --classic "bug" (#127 )
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the README and the referenced issues #118, #117, #113, and #127 to understand the terminal, font, default-configuration, and snap topics. Add a FAQ or Known Issues section covering the relevant items, then verify that the README links and wording are accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100