lsd-rs / lsd-rs/lsd

[DOC] doc.md + `man 1 lsd` fail to list custom theme-ing

Open
#1,095 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/doc
Dominant language
Rust
Stars
16.2k
Forks
510
PR merge metrics
No merged PRs in 30d

Description

🤔 manpages should list file(s) associated to the program near the bottom of the the page.
Please add the following section @ https://github.com/lsd-rs/lsd/blob/master/doc/lsd.md?plain=1#L167
PS; I don't know how well PANDOC formats Markdown links to Manpages!
……………………………………………………………………………………………………………………………

# FILES

`$HOME/.config/lsd/config.yaml`
`$HOME/.config/lsd/colors.yaml`
`$HOME/.config/lsd/icons.yaml`

: Download the optional configuration files from the Github LSD repository.
[ConfigurationTemplate](https://github.com/lsd-rs/lsd/tree/master?tab=readme-ov-file#config-file-content)

[ThemeColors](https://github.com/lsd-rs/lsd/tree/master?tab=readme-ov-file#color-theme-file-content)

[ThemeIcons](https://github.com/lsd-rs/lsd/tree/master?tab=readme-ov-file#icon-theme-file-content)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in doc/lsd.md around line 167 and inspect how it is converted to the `man 1 lsd` page. Add a FILES section listing the three configuration paths and their repository links, then verify that the generated manpage formats the Markdown links acceptably.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.