[DocC] Add @EditLink metadata directive for article “Edit this Page” links

Development Swift-DocC
1

I’m proposing a new DocC metadata directive: @EditLink(url:), with optional @EditLink(isDisabled:).

Motivation:

  • Allow manual per-article control of “Edit this Page” link.
  • Current automatic SourceRepository mapping works globally, but some pages need explicit override or disable behavior.

This is currently implemented in PR:

Question for feedback:

  • Is adding this user-facing syntax acceptable?
  • Should this be directive-based, or handled another way?
2

Hi,
There's a fair amount of information missing from this post that makes it difficult to have a meaningful discussion about the proposed addition.

This message briefly summarizes the evolution process for DocC and links to several pitches/proposals—from both people who contribute to DocC frequently and people who are first time contributors—that you can use as inspiration when writing your own pitch/proposal.

At this stage in the discussion, the implementation is less relevant. Instead, it would be good to focus the discussion on:

  • What is the problem statement that this is solving?
  • How does the proposed solution solve that problem?
  • Details about any user-facing syntax that the proposed solution would introduce
  • A brief description of one or more viable alternatives and why the proposed solution solves the stated problem better than those alternatives
  • Any open questions that need to be discussed where the pitch/proposal doesn't make a specific recommendation.

Please update your proposal to have a short section for each of those topics so that it's easier for the community to discuss the proposal.