feat(docs): tell agents what Mergify is for in llms.txt - #12597
Open
jd wants to merge 1 commit into
Conversation
This was referenced Aug 28, 2026
Member
Author
|
This pull request is part of a Mergify stack:
|
This was referenced Aug 28, 2026
Contributor
Merge Protections🔴 3 of 7 protections blocking · waiting on 👀 reviews and ⛓️ dependency
🔴 ⛓️ Depends-On RequirementsWaiting for
This rule is failing.Requirement based on the presence of
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
Show 4 satisfied protections🟢 🤖 Continuous Integration
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
jd
force-pushed
the
devs/jd/agentic-readiness/tell-agents-what-mergify-llms-txt--03f7b473
branch
from
August 28, 2026 13:33
e7b612f to
f0b222b
Compare
Member
Author
Revision history
|
There was a problem hiding this comment.
Pull request overview
This PR enriches the generated llms.txt endpoint so an agent can quickly decide whether Mergify is relevant to a task and, if so, how to consume the docs and API in machine-friendly ways.
Changes:
- Adds a “When to use Mergify” section describing concrete use-cases and explicitly stating out-of-scope constraints (GitHub-only).
- Adds a “For agents” section pointing to machine-readable surfaces (Markdown variants, OpenAPI, sitemap, and
.mergify.ymlJSON Schema). - Inserts these sections ahead of the existing auto-generated navigation-based page index.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
jd
marked this pull request as ready for review
August 28, 2026 14:08
jd
force-pushed
the
devs/jd/agentic-readiness/tell-agents-what-mergify-llms-txt--03f7b473
branch
from
August 28, 2026 14:37
f0b222b to
8e8ca33
Compare
`llms.txt` was a page index and nothing else: an agent could see every URL we publish and still not know whether Mergify was the right tool for the task in front of it, or how to call it. Add two sections above the index. "When to use Mergify" names the jobs concretely — keeping main green, merging at volume without the CI bill, diagnosing CI, flaky tests, merge requirements GitHub cannot express, stacked PRs — and, just as usefully, says what is out of scope. GitHub only, no other code host; GitLab appears solely as a source of CI results. That one line saves an agent from planning an integration that does not exist, which is worth more than another paragraph of capabilities. "For agents" points at the machine-readable surfaces: the `.md` twin of every page and the `Accept: text/markdown` equivalent, the OpenAPI document with its base URL and auth scheme, the sitemap, the `.mergify.yml` JSON Schema, and how to install the CLI. That last one because naming a CLI without an install path leaves an agent exactly where it started; the paths are the Homebrew tap, the install script and the Windows release zip, per /cli/usage. Change-Id: I03f7b473ced0969e850d78b48758e1849535062f
jd
force-pushed
the
devs/jd/agentic-readiness/tell-agents-what-mergify-llms-txt--03f7b473
branch
from
August 28, 2026 15:09
8e8ca33 to
fbf4750
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
llms.txtwas a page index and nothing else: an agent could see every URL wepublish and still not know whether Mergify was the right tool for the task in
front of it, or how to call it.
Add two sections above the index.
"When to use Mergify" names the jobs concretely — keeping main green, merging
at volume without the CI bill, diagnosing CI, flaky tests, merge requirements
GitHub cannot express, stacked PRs — and, just as usefully, says what is out of
scope. GitHub only, no other code host; GitLab appears solely as a source of CI
results. That one line saves an agent from planning an integration that does
not exist, which is worth more than another paragraph of capabilities.
"For agents" points at the machine-readable surfaces: the
.mdtwin of everypage and the
Accept: text/markdownequivalent, the OpenAPI document with itsbase URL and auth scheme, the sitemap, the
.mergify.ymlJSON Schema, and howto install the CLI. That last one because naming a CLI without an install path
leaves an agent exactly where it started; the paths are the Homebrew tap, the
install script and the Windows release zip, per /cli/usage.
Depends-On: #12596