Skip to content
This repository was archived by the owner on Oct 28, 2024. It is now read-only.
This repository was archived by the owner on Oct 28, 2024. It is now read-only.

Remove two-part links #4

@technosophos

Description

@technosophos

I don't know why, but the convention in these docs seems to be to use the "detached link" (aka "reference links") style:

I like [FOO].

[FOO]: http://example..com

While I understand that some people think this style is tidier, it has the following drawbacks, all of which have bitten me while attempting to work on these docs:

  1. It is easy to orphan a link when the name and the target are so far apart
  2. It is easy to accidentally override a link by re-declaring the reference between the initial usage and the intended reference
  3. It is hard (and interruptive of flow) to see a link and then figure out where it goes. Sometimes it requires scrolling far down in the doc, losing one's place in the editorial flow
  4. To stay in flow, one may choose not to look up the link (e.g. "Oh, [FOO] must go to the Foo homepage") when in fact that assumption is wrong
  5. It is highly subjective where the references should go, and consequently it is hard to track down where to find them.

I understand using that syntax if you have a canonical (and small) set of URLs that need to be re-used... but to do all URLs this way feels like it causes significant editorial pain (at the risk of increased inaccuracy). Are there good reasons to keep this style, or can we use inline links instead?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions