Skip to content

docs(readme): badge and pitch for quarry pairing - #16

Merged
GentBajko merged 1 commit into
mainfrom
docs/quarry-pitch
Sep 5, 2026
Merged

docs(readme): badge and pitch for quarry pairing#16
GentBajko merged 1 commit into
mainfrom
docs/quarry-pitch

Conversation

@GentBajko

@GentBajko GentBajko commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Follow-up to #15, which merged just before this commit reached the branch.

Adds the reciprocal quarry link to the README header: a "pairs with quarry" badge in the shield row (quarry's brand color, matching its "pairs with Capstone" badge pointing back here) and a one-paragraph pitch for multi-repo users under the flow diagram. The GentBajko/quarry link resolves once quarry is published.

Summary by Sourcery

Promote cross-repository documentation workflows by adding Quarry integration details to the README.

Enhancements:

  • Highlight Quarry integration in the README with a reciprocal badge and a concise cross-repository documentation pitch.

Documentation:

  • Document how Quarry indexes Capstone references across multiple repositories for dependency and impact queries.

Quarry's README already points here; this is the reciprocal link, in
the badge row and as a one-paragraph pitch for multi-repo users under
the flow diagram.
@sourcery-ai

sourcery-ai Bot commented Sep 5, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The README now promotes the reciprocal Capstone–Quarry pairing through a linked badge and a concise description of Quarry’s cross-repository documentation capabilities.

File-Level Changes

Change Details Files
Add reciprocal Quarry integration messaging to the README.
  • Add a linked, brand-colored “pairs with quarry” badge to the header shield row.
  • Add a centered multi-repository user pitch explaining Quarry’s indexed cross-repo documentation workflow and its relationship to Capstone.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.md" line_range="49-50" />
<code_context>

+<p align="center">
+  <strong>Running a fleet of repos?</strong>
+  <a href="https://github.com/GentBajko/quarry">Quarry</a> gathers every
+  capstone reference into one indexed docs repo, so "what breaks if I
+  change this endpoint" is a one-line query from any terminal.<br>
+  Capstone writes the edges; quarry walks them.
+</p>
</code_context>
<issue_to_address>
**nitpick:** The pitch states that Quarry gathers every Capstone reference, but this repository documents that Quarry indexes specifically the cross-repo `09-interfaces.md` tables rather than all Capstone references. Multi-repo users are therefore promised a complete indexed reference set that the integration does not provide.

**Triggers:** When users interpret the pitch as covering arbitrary Capstone documentation or references, not just declared cross-repo interfaces.

**Suggested fix:** Change the claim to say that Quarry gathers and indexes Capstone's declared cross-repo interface references.

```suggestion
  <a href="https://github.com/GentBajko/quarry">Quarry</a> gathers and indexes Capstone's declared
  cross-repo interface references into one indexed docs repo, so "what breaks if I
```
</issue_to_address>

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread README.md
Comment on lines +49 to +50
<a href="https://github.com/GentBajko/quarry">Quarry</a> gathers every
capstone reference into one indexed docs repo, so "what breaks if I

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: The pitch states that Quarry gathers every Capstone reference, but this repository documents that Quarry indexes specifically the cross-repo 09-interfaces.md tables rather than all Capstone references. Multi-repo users are therefore promised a complete indexed reference set that the integration does not provide.

Triggers: When users interpret the pitch as covering arbitrary Capstone documentation or references, not just declared cross-repo interfaces.

Suggested fix: Change the claim to say that Quarry gathers and indexes Capstone's declared cross-repo interface references.

Suggested change
<a href="https://github.com/GentBajko/quarry">Quarry</a> gathers every
capstone reference into one indexed docs repo, so "what breaks if I
<a href="https://github.com/GentBajko/quarry">Quarry</a> gathers and indexes Capstone's declared
cross-repo interface references into one indexed docs repo, so "what breaks if I

@GentBajko
GentBajko merged commit 975fe03 into main Sep 5, 2026
1 check passed
@GentBajko
GentBajko deleted the docs/quarry-pitch branch September 5, 2026 14:01
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.

1 participant