Skip to content

[Feature/Proposal] Add "Edit Page" feature in documentation site for community contributions #222

@shahincsejnu

Description

@shahincsejnu

Summary

The current Catena-X documentation site (https://catenax-ev.github.io/) does not provide an “Edit this page” option. This makes it difficult for community members to directly propose fixes for typos, grammar issues, or improvements while browsing the docs. Adding such a feature would improve collaboration and documentation quality.

Goals

  • Provide an “Edit this page” link or button on each documentation page.
  • Link the edit button to the respective source in GitHub.
  • Encourage contributors to quickly fix typos and propose improvements.

Proposed Solution/Approach

Add a feature in the documentation site that places an “Edit this page on GitHub” button at the top or bottom of each doc page.
This button should link to the corresponding file in the GitHub repo (e.g., https://github.com/catenax-eV/catenax-ev.github.io/edit/main/docs/...).

This is a common practice in many open-source projects and lowers the barrier for community contributions.

Acceptence Criteria

  • An edit link is visible on every doc page.
  • Clicking the link opens the corresponding source file in GitHub.
  • Contributors can easily fork and propose changes via pull requests.

Metadata

Metadata

Assignees

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