Skip to content

Conversation

@PierreDillard
Copy link
Collaborator

  • Enable in-browser edits via MkDocs Material .
  • Hide edit button on Filters/, MP4Box/ and homepage .
  • Keep a clear header link to gpac/gpac ; repo_url now points to gpac/wiki.

Copilot AI review requested due to automatic review settings October 6, 2025 12:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds an "Edit this page" feature to the GPAC wiki using MkDocs Material while keeping generated content read-only. It configures the wiki repository for editing, adds a dedicated link to the main GPAC source code in the header, and selectively hides the edit button on auto-generated pages.

Key changes:

  • Configured MkDocs Material's edit functionality to point to gpac/wiki repository
  • Added conditional logic to hide edit buttons on generated pages (Filters/, MP4Box/, homepage)
  • Added a dedicated GPAC source code link in the header to maintain visibility of the main repository

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
mkdocs.yml Configures edit functionality, updates repo URLs, and adds social links
overrides/base.html Adds conditional edit button display logic
overrides/partials/header.html Adds dedicated GPAC source code link in header

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@rbouqueau
Copy link
Member

Wow, sounds great! Who would be the committer when such edits are made?

@PierreDillard
Copy link
Collaborator Author

Wow, sounds great! Who would be the committer when such edits are made?

The committer is always the authenticated user who edits and saves the file in the online editor.
This is managed entirely by the GitHub web interface. https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/ ,https://www.mkdocs.org/user-guide/configuration/#edit_uri

@nlsdvl
Copy link
Collaborator

nlsdvl commented Nov 28, 2025

Thanks a lot for setting this up @PierreDillard ! Not sure if the wiki repo icon is worth displaying, but it's really nice to be able to edit this content directly from the relevant pages.

@nlsdvl nlsdvl merged commit 279aaa9 into master Nov 28, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants