Skip to content

docs: usage & integration guides + real examples - #2

Merged
anil-rome merged 1 commit into
mainfrom
docs-usage-guides
Jul 20, 2026
Merged

docs: usage & integration guides + real examples#2
anil-rome merged 1 commit into
mainfrom
docs-usage-guides

Conversation

@anil-rome

Copy link
Copy Markdown
Contributor

Addresses feedback that the docs were too high-level with few examples and no integration guides.

  • New docs/GUIDES.md — real command output (verbatim from Hadrian), plus how to fold rome into: an AI agent via MCP (step-by-step), the agent grounding loop, shell/jq recipes (incl. pair-a-wrapper-by-mint), CI checks, and an end-to-end 'build a price-reading contract' walkthrough.
  • README — a real-output example block + a one-line recipe; links the guides.
  • Every example verified against a live run (caught + fixed a wrong contracts jq shape in review). Docs-only; 27/27 tests green, leak-clean.

Address 'too high-level / few examples / no integration guides': new
docs/GUIDES.md with real command output, an MCP-into-agent walkthrough, the
agent grounding loop, shell/jq recipes, CI usage, and an end-to-end example.
README gains a real-output block + a one-line pair-by-mint recipe. Every
example is verbatim from a live Hadrian run.
@anil-rome
anil-rome merged commit 201c70f into main Jul 20, 2026
6 checks passed
@anil-rome
anil-rome deleted the docs-usage-guides branch July 20, 2026 12:11
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