eza-community/eza

bug: Problems with man pages

Open

#981 opened on May 10, 2024

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Rust (439 forks)batch import
errorsgood first issuetype: docs

Repository metrics

Stars
 (21,783 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Those are the ones I spotted right away, if there are more, please add in comments.

  1. There is no documentation for --absolute option
  2. Man pages contain $version string, which I think should be replaced with an actual eza version number
  3. in "SEE ALSO" section, man pages still point to markdown files, for example eza_colors.5.md . The .md suffix should be removed in man pages.

Contributor guide

Research direction
Inspect the man page source files (likely in the 'man' directory) and update them: add documentation for absolute, replace $version with the actual eza version number, and remove the '.md' suffix from links in the SEE ALSO section.
Tech stack
rust
Domain
clidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitman pages
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90