Skip to content

feat: add Edit on GitHub link to documentation pages - #19

Merged
barredterra merged 5 commits into
version-15from
feat/edit-on-github
Aug 13, 2026
Merged

feat: add Edit on GitHub link to documentation pages#19
barredterra merged 5 commits into
version-15from
feat/edit-on-github

Conversation

@barredterra

Copy link
Copy Markdown
Member

No description provided.

@barredterra barredterra linked an issue Aug 12, 2026 that may be closed by this pull request
@greptile-apps

greptile-apps Bot commented Aug 12, 2026

Copy link
Copy Markdown

Confidence Score: 4/5

The PR is not yet safe to merge because stale remote-tracking metadata can expose an Edit on GitHub link that targets a deleted branch.

Branch selection validates cached local Git metadata rather than the branch's current existence in the configured GitHub repository, so a deleted branch can still be embedded in the edit URL.

Files Needing Attention: compendium/docs.py

Fix All in Greploop

Fix All in Cursor

Prompt To Fix All With AI
### Issue 1
compendium/docs.py:612
**Stale remote ref breaks link**

If a canonical remote branch is deleted after the checkout last fetched it, the locally cached remote-tracking ref still passes this check, causing the displayed Edit on GitHub link to target the deleted branch and open a 404.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (4): Last reviewed commit: "fix: resolve GitHub edit branch from the..." | Re-trigger Greptile

Comment thread compendium/docs.py Outdated
Comment thread compendium/docs.py Outdated
Comment thread compendium/docs.py Outdated
@0xD0M1M0

Copy link
Copy Markdown

What about Private Repos?

Comment thread compendium/docs.py
@barredterra
barredterra merged commit 4165374 into version-15 Aug 13, 2026
3 of 4 checks passed
@barredterra
barredterra deleted the feat/edit-on-github branch August 13, 2026 15:23
@barredterra

Copy link
Copy Markdown
Member Author

What about Private Repos?

Users will be told by GitHub that they don't have edit access.

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.

Add "Edit on GitHub" button linking to the doc source file

2 participants