docs: fix man page cross-references to use proper man page notation#1751
Open
claw-explorer wants to merge 1 commit intoeza-community:mainfrom
Open
docs: fix man page cross-references to use proper man page notation#1751claw-explorer wants to merge 1 commit intoeza-community:mainfrom
claw-explorer wants to merge 1 commit intoeza-community:mainfrom
Conversation
Replace markdown-style links with .md suffixes in SEE ALSO sections with standard man page notation (e.g., **eza_colors**(5)). The .md extensions were appearing literally in rendered man pages, making the references non-functional. This also fixes the inline reference to eza_colors.5.md in the EZA_COLORS environment variable documentation. Fixes part of eza-community#981
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix man page cross-references in all three man pages to use standard man page notation instead of markdown-style links with
.mdsuffixes.Changes
eza_colors.5.mdreference in EZA_COLORS docsBefore (rendered in man page)
After (rendered in man page)
The markdown-style
[text](file.md)links were appearing literally in rendered man pages (viapandoc), making the references look broken and non-functional. Standard man page notation (**name**(section)) renders correctly as bold text with the section number.Partially fixes #981 (item 3: SEE ALSO section pointing to .md files).