Feat/sync develop

[manishdex25]

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for the Chain Events webhook sidecar, including an overview, quick start guide, and configuration reference.
  • Added guides for webhook payload verification, registry API usage, rate-limiting optimization, OpenTelemetry telemetry setup, and scaling with high availability.
  • Added example Grafana dashboards for fleet health and webhook event monitoring.

[coderabbitai]

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

This pull request adds comprehensive documentation for the trustvc-chain-events ETR webhook sidecar service, including setup guides, configuration references, API documentation, rate-limit tuning, deployment patterns, and pre-built Grafana dashboards for monitoring.

Changes

Chain Events (ETR Webhook) Documentation

Layer / File(s)	Summary
Overview & service foundation docs/how-tos/chain-events/overview.md	Introduces the chain-events service, CloudEvents delivery format with signature headers, self-hosted sidecar comparison, supported chains, transport modes, prerequisite database configuration, and links to next-step documentation.
Quick start and configuration docs/how-tos/chain-events/quick-start.md, docs/how-tos/chain-events/configuration.md, static/docs/chain-events/config.example.json	End-to-end setup instructions for container image pulling, Ed25519 signing key generation, config.json creation with chain/RPC/webhook fields, .env setup with environment variables, Docker and Docker Compose run paths, startup verification, and example configuration template for multi-chain replay/polling setups.
Webhook payloads, signatures, and rate limits docs/how-tos/chain-events/webhook-payload.md, docs/how-tos/chain-events/rate-limits.md	HTTP POST request format with CloudEvents 1.0 JSON structure and signature verification implementations (Node.js and Python), supported event types, RPC rate-limit problem during startup replay, batch configuration tuning, and recommended settings for public/paid/HTTP-polling RPC tiers.
Scaling, registry management, and health checks docs/how-tos/chain-events/scaling.md, docs/how-tos/chain-events/registry-api.md	Single-instance and horizontal-scaling patterns with database-backed leasing to prevent duplicate delivery, Runtime Registry API endpoints (POST/GET/DELETE) for managing Token Registry contracts, Docker Compose and AWS ECS/Fargate deployment examples with Secrets Manager integration, and orchestrator health-check configuration.
Telemetry, metrics, and Grafana dashboards docs/how-tos/chain-events/opentelemetry.md, static/docs/chain-events/grafana-fleet-health.json, static/docs/chain-events/grafana-webhook-events.json	OpenTelemetry export configuration with environment variables for any OTLP-compatible backend (Grafana Cloud, Datadog, New Relic, self-hosted), metrics and tracing spans emitted by the service, and two complete pre-built Grafana dashboards with import steps and panel breakdowns for fleet/chain health and webhook event monitoring.
Documentation site navigation sidebars.json	Docusaurus sidebar category entry for "Chain Events (ETR Webhook)" with nested documentation pages added under docs root and positioned before existing "implementing-qr-codes" category.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• TrustVC/TrustVC-Documentation#14: Adds identical "Chain Events (ETR Webhook)" documentation pages, config, and Grafana dashboard assets with direct file-level overlap.
• TrustVC/TrustVC-Documentation#15: Modifies docs/how-tos/chain-events/opentelemetry.md in the optional variables section, indicating concurrent edits to the same documentation file.

Suggested reviewers

• rongquan1
• RishabhS7

Poem

🐰 Hop, hop, the docs now bloom,
Chain events escaping from the gloom,
Dashboards, configs, webhooks all in place,
A sidecar's guide at a rapid pace! 📊✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Feat/sync develop' is vague and generic, using non-descriptive terms that don't convey meaningful information about the changeset's content.	Use a descriptive title that summarizes the main change, such as 'Add Chain Events documentation (overview, configuration, quick-start, webhooks, scaling)' or 'Docs: Add Chain Events webhook sidecar guide'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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 feat/sync-develop

---

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