Skip to content

doc: add a new way to link to guides - #2310

Open
jvns wants to merge 1 commit into
gitgitgadget:masterfrom
jvns:linkguide
Open

jvns wants to merge 1 commit into
gitgitgadget:masterfrom
jvns:linkguide

Conversation

@jvns

@jvns jvns commented Nov 12, 2026

Copy link
Copy Markdown

not totally sure this is a good idea just wanted to write it up before I forget and add it to my increasingly long list of drafts that I may or may not submit to the list.

Right now in the man pages the links to the guides look like this:
gitmergeconflicts[7]. There are two ways to access the guide:
'git help mergeconflicts' and 'man gitmergeconflicts'.

We want to encourage the use of 'git help' to access the Git
documentation, but it's not obvious to figure out how to access
gitmergeconflicts[7] from 'git help'. The user has to know that they
should remove either 'git' from the beginning (except for 'gitk',
where the 'git' should be left in), and then run 'git help <basename>'.

Add a new AsciiDoc macro called 'linkguide' that formats the link as
`git help <name>' to make it more obvious how to access the guide.
@gitgitgadget

gitgitgadget Bot commented Nov 12, 2026

Copy link
Copy Markdown

There is an issue in commit 2d7fcc8:
doc: add a new way to link to guides

  • Commit not signed off

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant