Skip to content

Add "Edit this page" functionality #171

@bmorelli25

Description

@bmorelli25

Overview

To encourage community contributions and make it easier for users to suggest improvements to our documentation, we should implement an "Edit this page" button on each documentation page. This button would link directly to the corresponding Markdown file on GitHub, allowing users to quickly propose changes.

Acceptance Criteria

  • Add an "Edit this page" button to every documentation page
  • Button should link to the correct Markdown file in the GitHub repository
  • Link should open in GitHub's edit mode (using the /edit/main/ path)
  • Links should point to the correct branch (main)
  • Functionality should work across all documentation pages

Additional Notes

  • Could potentially track usage metrics to see how often this feature leads to contributions

Examples

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions