lsd-rs/lsd

Improve the documentation

Open

#120 创建于 2019年2月9日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)Rust (13,400 star) (434 fork)batch import
help wantedkind/enhancement

描述

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 )

贡献者指南

技术栈
rust
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic gitfamiliarity with Markdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.