docs(readme): badge and pitch for quarry pairing - #16
Conversation
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.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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.
| <a href="https://github.com/GentBajko/quarry">Quarry</a> gathers every | ||
| capstone reference into one indexed docs repo, so "what breaks if I |
There was a problem hiding this comment.
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.
| <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 |
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:
Documentation: