Page MenuHomePhabricator

Connect manual pages like "arc help --full" to online versions
Closed, WontfixPublic

Description

The basic example I have in mind is to offer pages like http://git-scm.com/docs/git-commit which do little more than duplicate the manual pages with some links and CSS automatically applied. There are three reasons I make this suggestion:

  1. When I tried to get Arcanist up and running, my first instinct was to Google it, second instinct was to open the tool and browse the man pages. Having these pages for Git generally makes it easier to find help online, and it surely minimizes duplication of effort writing documentation.
  2. Displaying web help offers the ability to get stylish with colors and fonts and retweet buttons: this makes documentation easier to read.
  3. If man pages are linked to articles in the user documentation section, they are nudged that much closer to the "edit" buttons for contributors. You could even even try sending people to the public wiki pages to get things rolling.

Event Timeline

abrahams raised the priority of this task from to Needs Triage.
abrahams updated the task description. (Show Details)
abrahams updated the task description. (Show Details)
abrahams added a subscriber: abrahams.
epriestley claimed this task.
epriestley added a subscriber: epriestley.

A lot of arc help is version dependent, contextual, configuration-dependent, or extension-dependent, and this trend will only accelerate in the future. arc help is accurate; Googling for stuff will often get you help for a different version/configuration. Usage documentation is already available online.