Automatic Documentation Refresh via GitHub README Badge

[menshikovs]

Problem

When a GitHub repository is updated, its Context7 documentation may become outdated until manually refreshed.

Maintainers can use the "Refresh library documentation" button, but doing so after every update is inconvenient. GitHub Actions can automate this, but require extra configuration and API keys.

Proposed Solution

Introduce an official Context7 Auto-Refresh Badge that developers can add to their README.md:

[![Context7 Auto Refresh](https://context7.com/badge/owner/repo.svg)](https://context7.com/owner/repo)

Adding this badge would automatically enable documentation synchronization between GitHub and Context7.

Whenever new commits are pushed to the default branch, Context7 would automatically refresh the documentation.

No GitHub Actions, API keys, or additional configuration required.

How It Could Work

1. A developer adds the badge to their README.
2. Context7 detects it and enables automatic synchronization.
3. Context7 monitors new commits and triggers documentation refreshes.
4. The badge displays the current documentation status.

Badge Statuses

• 🟢 Up to date — Documentation is current.
• 🟡 Updating — Refresh in progress.
• 🔴 Outdated — New commits haven't been indexed.
• ⚪ Not indexed — Library hasn't been indexed yet.

Benefits

• Zero configuration: Just one line in README.
• No API keys or GitHub Actions required.
• Automatic synchronization with repository changes.
• Visible documentation status directly in README.
• Better developer experience for open-source maintainers.

Possible Implementation

The badge could serve as an opt-in signal.

Context7 could periodically compare the latest GitHub commit SHA with the last indexed commit and queue a refresh when changes are detected.

To reduce unnecessary indexing, refreshes could be rate-limited, deduplicated, or limited to relevant file changes.

Optional GitHub App integration could enable instant webhook-based updates.

Final Thoughts

This would be a great quality-of-life improvement for Context7.

Add a badge → Push code → Context7 updates automatically.

One line of Markdown should be enough to keep documentation up to date.

Would love to hear what the Context7 team thinks!

[menshikovs]

For reference, DeepWiki already supports a similar approach: adding its badge to a repository's README enables automatic weekly documentation refreshes.

Reference: https://github.com/CognitionAI/deepwiki

I think bringing a similar zero-configuration experience to Context7 would be very useful, especially with commit-based change detection and visible indexing status.