Skip to content

docs: add Chain Events category to sidebar#14

Merged
RishabhS7 merged 5 commits into
developfrom
TT-1360/create-tutorial-for-blockchain-listening
Jun 1, 2026
Merged

docs: add Chain Events category to sidebar#14
RishabhS7 merged 5 commits into
developfrom
TT-1360/create-tutorial-for-blockchain-listening

Conversation

@manishdex25
Copy link
Copy Markdown
Contributor

@manishdex25 manishdex25 commented May 29, 2026

Introduces a new category for Chain Events (ETR Webhook) in the sidebar, including links to various how-to guides related to chain events, such as overview, quick start, configuration, and more.

Summary by CodeRabbit

Documentation

  • Added comprehensive guides for Chain Events (ETR Webhook Sidecar):
    • Quick Start guide for local setup
    • Configuration reference with environment variables and examples
    • Webhook payload format and signature verification
    • Registry API documentation for dynamic configuration
    • Rate limiting and performance optimization guidance
    • Scaling and high-availability deployment patterns
    • OpenTelemetry integration for distributed tracing and metrics
    • Pre-built Grafana dashboards for webhook events and fleet health monitoring

Review Change Stack

Introduces a new category for Chain Events (ETR Webhook) in the sidebar, including links to various how-to guides related to chain events, such as overview, quick start, configuration, and more.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2fc59eba-f79b-4ffc-bb43-1c4fcbe70e55

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch TT-1360/create-tutorial-for-blockchain-listening

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

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/how-tos/chain-events/opentelemetry.md`:
- Around line 22-31: The doc uses two different OTEL_SERVICE_NAME values
("trustvc-chain-events" and "trustvc-webhook-events") which will split
telemetry; pick a single canonical service name (e.g.,
OTEL_SERVICE_NAME=trustvc-chain-events) and update every occurrence in this
page: the example env block, the table Default value for `OTEL_SERVICE_NAME`,
and any text references so they all match the chosen canonical string.

In `@docs/how-tos/chain-events/quick-start.md`:
- Around line 151-158: The code fence containing the logged startup lines (the
block starting with INFO [startup]: trustvc-webhook-events...) is missing a
language tag which triggers MD040; update the opening fence from ``` to a tagged
fence like ```text or ```console so the block becomes a language-specified code
fence, ensuring markdownlint passes while leaving the log contents unchanged.

In `@docs/how-tos/chain-events/rate-limits.md`:
- Around line 104-107: The snippet shows "logLevel" as top-level JSON which
conflicts with the rest of the docs where it's nested under the server config;
update the example so it demonstrates the correct path by placing logLevel under
the server object (i.e., server -> logLevel) and add a short clarifying sentence
that if your app uses a top-level config structure the alternate placement is
possible, referencing the "logLevel" key and the "server" object so readers know
where to apply the setting.
- Around line 31-36: The fenced code block in the rate-limits doc is unlabeled
(markdownlint MD040); update the fence to include a language specifier (e.g.,
add "text" after the opening ``` in the diagram block shown in the diff) so the
block becomes ```text ... ```; locate the unlabeled diagram in
docs/how-tos/chain-events/rate-limits.md (the block starting with "Block
6,000,000 ──► [batch 1...") and add the language token to the opening fence to
satisfy linting and improve renderer consistency.

In `@docs/how-tos/chain-events/webhook-payload.md`:
- Around line 16-20: The markdown fenced code blocks in
docs/how-tos/chain-events/webhook-payload.md are missing language labels
(MD040); update each unlabeled triple-backtick block shown around the examples
(the block starting with "POST /your-endpoint" and the later block at lines
~107-109) to use ```text instead of ``` so they are labeled as plain text;
ensure both occurrences are changed to maintain lint compliance and consistent
rendering.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3017f976-e550-4ab9-a4a2-421bbc2a9eb8

📥 Commits

Reviewing files that changed from the base of the PR and between 9904e94 and 3b9fa5f.

⛔ Files ignored due to path filters (1)
  • static/docs/etr-listener/how-it-works.png is excluded by !**/*.png
📒 Files selected for processing (12)
  • docs/how-tos/chain-events/configuration.md
  • docs/how-tos/chain-events/opentelemetry.md
  • docs/how-tos/chain-events/overview.md
  • docs/how-tos/chain-events/quick-start.md
  • docs/how-tos/chain-events/rate-limits.md
  • docs/how-tos/chain-events/registry-api.md
  • docs/how-tos/chain-events/scaling.md
  • docs/how-tos/chain-events/webhook-payload.md
  • sidebars.json
  • static/docs/chain-events/config.example.json
  • static/docs/chain-events/grafana-fleet-health.json
  • static/docs/chain-events/grafana-webhook-events.json

Comment thread docs/how-tos/chain-events/opentelemetry.md Outdated
Comment thread docs/how-tos/chain-events/quick-start.md Outdated
Comment thread docs/how-tos/chain-events/rate-limits.md Outdated
Comment thread docs/how-tos/chain-events/rate-limits.md Outdated
Comment thread docs/how-tos/chain-events/webhook-payload.md Outdated
manishdex25 and others added 4 commits May 29, 2026 13:58
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Changed code block syntax from plain to text for better clarity in the quick start and webhook payload documentation sections.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Changed code block syntax from plain to text for improved clarity in the rate limits section.
@manishdex25 manishdex25 self-assigned this May 29, 2026
@manishdex25 manishdex25 requested review from RishabhS7 and rongquan1 and removed request for rongquan1 May 29, 2026 08:45
@RishabhS7 RishabhS7 merged commit b964147 into develop Jun 1, 2026
2 checks passed
@RishabhS7 RishabhS7 deleted the TT-1360/create-tutorial-for-blockchain-listening branch June 1, 2026 07:01
@coderabbitai coderabbitai Bot mentioned this pull request Jun 4, 2026
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.

2 participants