Skip to content

[UI] Fix “Edit This Page” Button Link #62

@idanlodzki

Description

@idanlodzki

Description:
The “Edit this page” button currently doesn’t work correctly — it redirects users to an unknown or invalid URL instead of the corresponding GitHub source file.

Goal:
Ensure the “Edit this page” button takes users directly to the correct file in the documentation repository, so contributors can easily submit edits or improvements.

Why:

  • Encourages community contributions by making edits simple and intuitive.
  • Improves user trust — broken links can make the site feel unfinished.
  • Aligns with best practices for open-source documentation workflows.

Suggested Fix:

  • Verify and update the base URL for GitHub edit links in the Docusaurus configuration (usually docusaurus.config.js).
  • Ensure the path dynamically matches the page being viewed.
  • Test across all documentation pages (including nested directories).

Example:
If a user is on /docs/setup/install, the button should link to:
https://github.com/OpsiMate/documentation/edit/main/docs/setup/install.md

Design Notes:
No UI change required — just fix the redirect logic.
Optionally, add a small tooltip or text like “Edit this page on GitHub” to clarify the purpose.

Image

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions