Skip to content

Add rel=edit link #38299

Open
Open
@capjamesg

Description

@capjamesg

Code of Conduct

What article on docs.github.com is affected?

The template for content pages.

What changes are you suggesting?

I have been working on documenting the history of rel=edit, a link relation that lets a page indicate that the linked resource can be used to edit the page. I wrote a spec at https://microformats.org/wiki/rel-edit based on prior art from the Universal Edit Button.

I would love support for this link relation so that a bookmarklet/browser extension can find the edit link for docs pages. I have a bookmarklet that looks for rel=edit (used on some of my personal projects) as well as various text anchors indicative of edit links (i.e. "Edit page", "Edit this page"). I noticed that GitHub's "Make a contribution" link uses different wording, so I thought rel=edit support would be terrific! My bookmarklet currently special cases for this wording.

rel=edit is not widely adopted, although I definitely would love to see more docs sites support it! I edit several documentation sites both professionally and personally. All the edit links are in different places between sites.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions