Skip to content

docs(readme): document the /validate playground and /consumers drill-down routes (agent:clawd) - #57

Merged
TargiX merged 1 commit into
mainfrom
clawd/signalops-readme-route-map
Nov 9, 2026
Merged

TargiX merged 1 commit into
mainfrom
clawd/signalops-readme-route-map

Conversation

@TargiX

@TargiX TargiX commented Nov 9, 2026 •

Copy link
Copy Markdown
Owner

agent:clawd

What changed

Docs-only README update: two shipped routes were missing from the route map.

  • /validate — the public playground for the v0 event contract (POST /api/events/validate, public verification only, zero storage; optional protected dev-ingest receipt inspection). Added to both "Live product boundaries" and "Routes".
  • /consumers/<id> — the synthetic consumer drill-down linked from the demo dashboard (account KPIs, operations, local spend-ceiling guard preview that never changes billing/credits/server policy). Added to "Routes".

Why

The README is the entry point for a public product, and its route map lagged behind src/app: both pages exist on main but were undocumented, so a reviewer or prospective pilot had no signpost to the validator playground.

Verification

  • Route existence checked against git ls-tree origin/main -- src/app (src/app/validate/page.tsx, src/app/consumers/[id]/page.tsx).
  • /validate behavior read from src/app/validate/page.tsx (calls POST /api/events/validate, then optionally POST /api/events).
  • /consumers/<id> behavior read from src/app/consumers/[id]/page.tsx and src/components/consumer-detail.tsx (mock-data backed, demo-only guard preview).
  • Docs-only change: no code, CI-relevant, or runtime behavior touched.

Summary by CodeRabbit

  • Documentation
    • Added guidance for validating sample or pasted event JSON in the public /validate playground.
    • Documented the synthetic consumer drill-down and local spend-ceiling preview, including that it does not affect billing, credits, or server-side policy.

@vercel

vercel Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
signalops Ready Ready Preview Nov 9, 2026 8:35am UTC

@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README now documents /validate, including public event validation and optional use of the protected development ingest seam. It also describes the synthetic consumer drill-down and its local spend-ceiling preview.

Changes: Route documentation

Layer / File(s) Summary
Document validation and consumer routes
README.md
The public-route list describes sample or pasted JSON validation through POST /api/events/validate without storage, followed by an optional receipt inspection through the protected development ingest seam. The Routes list documents the synthetic /consumers/<id> drill-down and notes that its local spend-ceiling preview does not affect billing, credits, or server-side policy.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: Minimal · up to f2751

The change documents existing routes; no actionable merge-blocking risk was identified.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the README documentation change and the two routes it covers, /validate and /consumers drill-down. The raw summary and PR objectives confirm the change is docs-only and touches the…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Title check

Explanation

The title names the README documentation change and the two routes it covers, /validate and /consumers drill-down. The raw summary and PR objectives confirm the change is docs-only and touches the README route map. The title is specific and accurate, and it has a conventional commit prefix. The trailing agent tag does not affect the check.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: ca03737f-8852-4874-9e21-231b5134b7eb
Commits

Reviewing files that changed from the base of the PR and between f27b879 and f2751d6.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

@TargiX
TargiX merged commit 731efff into main Nov 9, 2026
4 checks passed
@TargiX
TargiX deleted the clawd/signalops-readme-route-map branch November 9, 2026 12:10

This branch was successfully deployed

1 active deployment
Preview — f2751d65 Deployed Nov 9, 2026 by vercel[bot]
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