lsd-rs/lsd

Improve the documentation

Open

#120 opened on Feb 9, 2019

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Rust (13,400 stars) (434 forks)batch import
help wantedkind/enhancement

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)
  • Some documentation about the default configuration (#113)
  • The snap without --classic "bug" (#127 )

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic gitfamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
First, review the referenced issues #118, #117, #113, and #127 to understand the content that should be included in the FAQ or Known Issues section. Then, examine the current README file at the root of the repository to determine where to add the new section. Consider linking to relevant issues or external resources as needed. The goal is to create a clear, organized section that addresses common problems and configurations.