docs: reorder v2 sidebar, split examples, add quickstart install tabs

[scarmuega]

Acting on review feedback for the published v2 docs.

1. Sidebar order (was "weird")

New top-level order:

Introduction → How it works → Quick Start → Installation → Usage → Sources → Filters → Sinks → Configuration → Reference → Examples → Guides → Troubleshooting

• Sources → Filters → Sinks — fixes the backwards dataflow order (was Filters → Sources → Sinks); now matches how data actually flows and the daemon.toml block order.
• Standalone intro pages clustered at the top instead of "Quick Start" wedged alone between two collapsed groups.
• Reference moved below the config section (lookup material near the end).
• Intentional intra-group order added for Installation (binary → docker → source → k8s) and Usage (watch → dump → daemon → library), which were alphabetical-by-default.

All ordering is via _meta.yaml / sidebar.order — no file moves, no URL changes.

2. Examples split into Runnable vs Recipes

• Runnable examples (examples/) — the catalog of clone-and-run repo projects.
• Recipes (new examples/recipes.mdx) — the inline copy-paste daemon.toml snippets, moved out of the index. The two pages cross-link.

3. Quickstart install tabs

Step 1 now offers the full install-method tabs (Shell / PowerShell / Homebrew / npm), matching the Binary Releases page, instead of a single shell one-liner.

4. Evaluation: merge Usage + "Advanced Features"?

Recommendation: don't merge. Usage = CLI/entry points (watch/dump/daemon/library); the other group is optional daemon.toml config blocks ([intersect]/[cursor]/[retries]/[chain]/[metrics]/finalize). Merging would mix "how to run" with "how to configure" in one ~10-item group. Instead I renamed "Advanced Features" → "Configuration" (which is what it is) and repositioned it right after the component groups, where the config story lives. That addresses the muddled identity that prompted the question without conflating two different concerns.

Verification

Ran a full local astro build of txpipe/docs against this content (Chromium installed for Mermaid):

• 196 pages built, "Complete" — no MDX errors.
• The Tabs-in-Steps install block renders (all four tab labels + tab markup) — the same MDX list/JSX nesting that broke docs: fix MDX/Mermaid build errors in v2 docs #951, build-verified here.
• The new Recipes page renders with all three snippets; Runnable examples renders.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Reorganized navigation structure with updated section ordering
  • Renamed "Advanced Features" section to "Configuration"
  • Added new "Recipes" page featuring copyable daemon.toml configuration snippets
  • Restructured Examples page to emphasize runnable example projects with complete configuration
  • Enhanced Quick Start with tabbed installation instructions for Shell, PowerShell, Homebrew, and npm
  • Added explicit sidebar ordering across installation and usage documentation pages

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a452045d-917e-423c-94e9-d2295898e5a2

📥 Commits

Reviewing files that changed from the base of the PR and between 201eaa3 and 1aefd46.

📒 Files selected for processing (19)

• docs/v2/advanced/_meta.yaml
• docs/v2/advanced/index.mdx
• docs/v2/examples/_meta.yaml
• docs/v2/examples/index.mdx
• docs/v2/examples/recipes.mdx
• docs/v2/filters/_meta.yaml
• docs/v2/guides/_meta.yaml
• docs/v2/how_it_works.mdx
• docs/v2/installation/binary_release.mdx
• docs/v2/installation/docker.mdx
• docs/v2/installation/from_source.mdx
• docs/v2/installation/kubernetes.mdx
• docs/v2/quickstart.mdx
• docs/v2/reference/_meta.yaml
• docs/v2/sources/_meta.yaml
• docs/v2/usage/daemon.mdx
• docs/v2/usage/dump.mdx
• docs/v2/usage/library.mdx
• docs/v2/usage/watch.mdx

---

📝 Walkthrough

Walkthrough

Documentation restructuring across the docs/v2 tree: sidebar order values are adjusted for installation, usage, filters, sources, reference, and guides sections; the "Advanced Features" section is renamed "Configuration"; the examples index is rewritten to focus on runnable projects; a new recipes.mdx page is added with three daemon.toml snippets; and the quickstart page gains tabbed installation instructions.

Changes

Docs Navigation and Content Restructure

Layer / File(s)	Summary
Section and page sidebar ordering docs/v2/how_it_works.mdx, docs/v2/installation/*.mdx, docs/v2/usage/*.mdx, docs/v2/filters/_meta.yaml, docs/v2/sources/_meta.yaml, docs/v2/reference/_meta.yaml, docs/v2/guides/_meta.yaml, docs/v2/examples/_meta.yaml	sidebar.order values are added or updated across installation pages (1–4), usage pages (1–4), and section _meta.yaml files to establish a new navigation sequence throughout the sidebar.
"Advanced Features" renamed to "Configuration" docs/v2/advanced/_meta.yaml, docs/v2/advanced/index.mdx	Section label and page title are changed from "Advanced Features" to "Configuration"; section order moves from 70 to 60.
Examples restructure and new Recipes page docs/v2/examples/index.mdx, docs/v2/examples/recipes.mdx	Examples index is retitled "Runnable examples" with rewritten intro and a tip linking to the new recipes page; embedded recipe snippets are removed. New recipes.mdx adds three copy-pasteable daemon.toml examples: address-based transaction selection, JSONL file rotation with compression, and metadata regex matching.
Quickstart tabbed installation and next-steps links docs/v2/quickstart.mdx	Installation instructions are replaced with a <Tabs> block covering Shell (Mac/Linux), PowerShell, Homebrew, and npm. The "Where to go next" section is updated with separate links for runnable examples and recipes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• paulobressan

Poem

🐇 Hippity-hop, the docs got a trim,
Recipes now live on their very own whim!
"Advanced" became "Config" with a flick of the ear,
The sidebar in order, the path now is clear.
Install with a tab — Shell, Brew, or npm too,
A tidy doc warren, fresh carrots for you! 🥕

🚥 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 PR title accurately summarizes the three main changes: sidebar reordering, splitting examples into runnable examples and recipes, and adding installation tabs to the quickstart.
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/v2-sidebar-and-examples

---

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.}