docs: cover all four examples in README + mdbook

[copyleftdev]

The README ## Examples section only mentioned stock_anomalies.py, and the mdbook (docs/) had no examples coverage at all. This brings both up to date now that there are four worked examples.

• README — Examples section now lists all four (stock, journal, polymarket, synergy) with deep links into examples/README.md, plus the agent-calc synergy.
• mdbook — new docs/src/examples.md ("Worked examples") + a SUMMARY.md entry. Frames the examples as consuming the tq1 contract, with synergy_market.py as the "contracts composing with contracts" showcase.

The book's changelog page is already {{#include ../../CHANGELOG.md}}, so it auto-tracks the root CHANGELOG — no change needed there. mdbook build docs succeeds locally; docs/book/ is gitignored (CI pages.yml rebuilds and deploys). Docs-only — no workspace or gate impact.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Updated examples documentation with detailed descriptions of each example script and their use cases.
  • Added new worked examples guide covering example usage, exit codes, and how examples consume the tq1 contract.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: baa31870-db93-48e5-ae66-075c065afa12

📥 Commits

Reviewing files that changed from the base of the PR and between 9130a57 and 2de34e8.

📒 Files selected for processing (3)

• README.md
• docs/src/SUMMARY.md
• docs/src/examples.md

---

📝 Walkthrough

Walkthrough

This pull request adds comprehensive documentation for the examples/ directory. A new detailed guide page explains how example programs consume the tq1 contract and describes each example script. The README examples section is expanded to introduce worked examples and link to multiple example programs. A navigation entry is added to the documentation table of contents.

Changes

Examples Documentation

Layer / File(s)	Summary
Examples guide and documentation docs/src/examples.md, README.md, docs/src/SUMMARY.md	New examples.md page documents how example programs consume the tq1 envelope, their execution context, exit codes (0 clean, 1 anomalies, 2 error), and what each script surfaces. README examples section is reframed to introduce worked examples and link to stock, journal, polymarket, and synergy/agent-calc examples. Documentation table of contents gains a "Worked examples" entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• copyleftdev/anomalyx#64: Documentation updates expand on the same examples/stock_anomalies.py worked example introducing tq1 consumption from the retrieved PR.
• copyleftdev/anomalyx#66: Documentation updates reference the polymarket_anomalies.py example script and align with the retrieved PR adding that example and its examples/README.md.

Poem

🐰 The examples now shine with clarity bright,
Three docs dance together, a documentarian's delight—
From tq1 consumption to regime shifts found,
The worked examples are thoroughly bound.
No code was harmed, just prose was refined—
A guide for the curious, brilliantly signed! 📚

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: expanding documentation to cover all four examples in both README and mdbook.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs-examples-page

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}