docs: add Chain Events category to sidebar#14
Conversation
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.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (1)
static/docs/etr-listener/how-it-works.pngis excluded by!**/*.png
📒 Files selected for processing (12)
docs/how-tos/chain-events/configuration.mddocs/how-tos/chain-events/opentelemetry.mddocs/how-tos/chain-events/overview.mddocs/how-tos/chain-events/quick-start.mddocs/how-tos/chain-events/rate-limits.mddocs/how-tos/chain-events/registry-api.mddocs/how-tos/chain-events/scaling.mddocs/how-tos/chain-events/webhook-payload.mdsidebars.jsonstatic/docs/chain-events/config.example.jsonstatic/docs/chain-events/grafana-fleet-health.jsonstatic/docs/chain-events/grafana-webhook-events.json
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.
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