podman-container-tools/container-libs

Improve man page cross-links

Open

#827 opened on May 6, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (120 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (97 stars)
PR merge metrics
 (PR metrics pending)

Description

In our man pages maintained in Markdown, we can show links to other man pages within the project correctly in only one of 1) the GitHub web view, and 2) Linux man pages: if we use real web links in Markdown, they show correctly in GitHub, but md2man turns the link target into an extra text in the page.

Podman has a small pre-processing step to remove the links before running md2man; adopt that and update the man pages.

Contributor guide

Research direction
Examine Podman's link pre processing script and apply it to the Markdown man pages in this repository. Update all man pages to use the proper cross link format.
Tech stack
go
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdownman pages
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75