Skip to content

Consider amending “Edit this page” text #1172

@jeanas

Description

@jeanas

The edit-this-page theme component displays the text “Edit this page”. However, in most Sphinx documentation projects, this is a bit misleading: it can be construed as “This documentation is a Wiki, use this button to edit it [and you will see your changes applied instantly without vetting, like on a Wiki]”, rather than “This documentation is hosted on GitLab/GitHub, use this link to suggest an edit and it will be reviewed by the maintainers”.

Proposed new wording: “Suggest an edit”, or “Suggest an edit to this page” (not a native English speaker, is “to” the right preposition here?).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions