void-linux / void-linux/void-docs

Switch to using reference-style links

Open
#286 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
217
Forks
212
Avg merge
2d 21h
Merged PRs (30d)
1

Description

@jeffayle suggested here that we use reference-style links in the Handbook when linking to man pages. i like this idea, particularly as we factor out common information and increasingly link to page fragments: if all man page links can simply have the format [ls(1)], we won't have to worry about users being directed to a fragment which contains a non-linked man page reference.

Contributor guide

Open the contributing guide

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

Inspect the Handbook for links to man pages and review the linked discussion for the intended reference-style format. Convert the man-page links consistently, including links to page fragments, and verify that the Handbook renders with the intended references.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.