Skip to content

docs: add a CLI section and renumber the content tree around it - #451

Merged
HugoRCD merged 3 commits into
mainfrom
docs/cli-section
Jul 26, 2026
Merged

docs: add a CLI section and renumber the content tree around it#451
HugoRCD merged 3 commits into
mainfrom
docs/cli-section

Conversation

@HugoRCD

@HugoRCD HugoRCD commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Documents evlog map and gives the CLI a place on the site.

  • New 3.cli/ section: overview, map, rules, scoring, CI, doctor, telemetry.
  • Landing page entry for the CLI, plus the header menu filled in with the pages that were missing from it.
  • Three animated MDC components (MapScanFlow, MapScoreClimb, MapPrGate) showing the scan, the score climbing as rules are satisfied, and the --min-score gate on a PR.
  • Long code blocks wrapped in ::code-collapse, and prose pre now scrolls long lines instead of wrapping them, which was breaking the column alignment of the CLI output.
  • An early-days note: map is tested and safe to run, but it covers four frameworks and its rules are still being refined, so verdicts can move between releases.

82 of the 104 files are pure renames: inserting 3.cli/ pushed 3.integrate4.integrate, 4.use-cases5.use-cases, 5.extend6.extend and 6.reference7.reference. Redirects and their test cover the old paths.

Split out of #448, which now carries the CLI code alone. Docs only, no changeset.

@vercel

vercel Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
evlog-docs Ready Ready Preview, Comment, Open in v0 Jul 26, 2026 9:58am
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
evlog-telemetry Skipped Skipped Jul 26, 2026 9:58am
just-use-evlog Skipped Skipped Jul 26, 2026 9:58am

Request Review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@HugoRCD, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 25 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5d3e9112-734d-475c-8547-5dc131893c34

📥 Commits

Reviewing files that changed from the base of the PR and between f9cf6cb and d6623ef.

📒 Files selected for processing (104)
  • apps/docs/app/app.config.ts
  • apps/docs/app/components/app/AppHeaderCenter.vue
  • apps/docs/app/components/content/MapPrGate.vue
  • apps/docs/app/components/content/MapScanFlow.vue
  • apps/docs/app/components/content/MapScoreClimb.vue
  • apps/docs/app/components/content/StreamBus.vue
  • apps/docs/app/components/features/FeatureCliMap.vue
  • apps/docs/config/redirects.ts
  • apps/docs/content/0.landing.md
  • apps/docs/content/1.start/4.quick-start.md
  • apps/docs/content/2.learn/0.overview.md
  • apps/docs/content/3.cli/.navigation.yml
  • apps/docs/content/3.cli/0.overview.md
  • apps/docs/content/3.cli/1.map.md
  • apps/docs/content/3.cli/2.rules.md
  • apps/docs/content/3.cli/3.scoring.md
  • apps/docs/content/3.cli/4.ci.md
  • apps/docs/content/3.cli/5.doctor.md
  • apps/docs/content/3.cli/6.telemetry.md
  • apps/docs/content/4.integrate/.navigation.yml
  • apps/docs/content/4.integrate/0.overview.md
  • apps/docs/content/4.integrate/adapters/.navigation.yml
  • apps/docs/content/4.integrate/adapters/01.overview.md
  • apps/docs/content/4.integrate/adapters/cloud/.navigation.yml
  • apps/docs/content/4.integrate/adapters/cloud/01.axiom.md
  • apps/docs/content/4.integrate/adapters/cloud/02.otlp.md
  • apps/docs/content/4.integrate/adapters/cloud/03.posthog.md
  • apps/docs/content/4.integrate/adapters/cloud/04.sentry.md
  • apps/docs/content/4.integrate/adapters/cloud/05.better-stack.md
  • apps/docs/content/4.integrate/adapters/cloud/06.datadog.md
  • apps/docs/content/4.integrate/adapters/cloud/07.hyperdx.md
  • apps/docs/content/4.integrate/adapters/self-hosted/.navigation.yml
  • apps/docs/content/4.integrate/adapters/self-hosted/01.fs.md
  • apps/docs/content/4.integrate/adapters/self-hosted/02.nuxthub.md
  • apps/docs/content/4.integrate/adapters/self-hosted/03.memory.md
  • apps/docs/content/4.integrate/frameworks/.navigation.yml
  • apps/docs/content/4.integrate/frameworks/00.overview.md
  • apps/docs/content/4.integrate/frameworks/01.nuxt.md
  • apps/docs/content/4.integrate/frameworks/02.nextjs.md
  • apps/docs/content/4.integrate/frameworks/03.sveltekit.md
  • apps/docs/content/4.integrate/frameworks/04.nitro.md
  • apps/docs/content/4.integrate/frameworks/05.tanstack-start.md
  • apps/docs/content/4.integrate/frameworks/06.nestjs.md
  • apps/docs/content/4.integrate/frameworks/07.express.md
  • apps/docs/content/4.integrate/frameworks/08.hono.md
  • apps/docs/content/4.integrate/frameworks/09.fastify.md
  • apps/docs/content/4.integrate/frameworks/10.elysia.md
  • apps/docs/content/4.integrate/frameworks/11.react-router.md
  • apps/docs/content/4.integrate/frameworks/12.cloudflare-workers.md
  • apps/docs/content/4.integrate/frameworks/13.standalone.md
  • apps/docs/content/4.integrate/frameworks/14.astro.md
  • apps/docs/content/4.integrate/frameworks/15.orpc.md
  • apps/docs/content/4.integrate/frameworks/16.aws-lambda.md
  • apps/docs/content/5.use-cases/.navigation.yml
  • apps/docs/content/5.use-cases/0.overview.md
  • apps/docs/content/5.use-cases/1.client-logging.md
  • apps/docs/content/5.use-cases/2.ai-sdk/.navigation.yml
  • apps/docs/content/5.use-cases/2.ai-sdk/01.overview.md
  • apps/docs/content/5.use-cases/2.ai-sdk/02.usage.md
  • apps/docs/content/5.use-cases/2.ai-sdk/03.options.md
  • apps/docs/content/5.use-cases/2.ai-sdk/04.metadata.md
  • apps/docs/content/5.use-cases/2.ai-sdk/05.telemetry.md
  • apps/docs/content/5.use-cases/3.better-auth/.navigation.yml
  • apps/docs/content/5.use-cases/3.better-auth/01.overview.md
  • apps/docs/content/5.use-cases/3.better-auth/02.identify-user.md
  • apps/docs/content/5.use-cases/3.better-auth/03.middleware.md
  • apps/docs/content/5.use-cases/3.better-auth/04.client-sync.md
  • apps/docs/content/5.use-cases/3.better-auth/05.performance.md
  • apps/docs/content/5.use-cases/4.audit/.navigation.yml
  • apps/docs/content/5.use-cases/4.audit/01.overview.md
  • apps/docs/content/5.use-cases/4.audit/02.schema.md
  • apps/docs/content/5.use-cases/4.audit/03.recording.md
  • apps/docs/content/5.use-cases/4.audit/04.pipeline.md
  • apps/docs/content/5.use-cases/4.audit/05.compliance.md
  • apps/docs/content/5.use-cases/4.audit/06.recipes.md
  • apps/docs/content/5.use-cases/4.telemetry/.navigation.yml
  • apps/docs/content/5.use-cases/4.telemetry/01.overview.md
  • apps/docs/content/5.use-cases/4.telemetry/02.setup.md
  • apps/docs/content/5.use-cases/4.telemetry/03.ingest.md
  • apps/docs/content/5.use-cases/4.telemetry/04.reference.md
  • apps/docs/content/5.use-cases/5.enrichers.md
  • apps/docs/content/5.use-cases/5.eve.md
  • apps/docs/content/6.extend/.navigation.yml
  • apps/docs/content/6.extend/0.overview.md
  • apps/docs/content/6.extend/1.stream.md
  • apps/docs/content/6.extend/10.custom-framework.md
  • apps/docs/content/6.extend/2.fs-reader.md
  • apps/docs/content/6.extend/3.consumer-recipes.md
  • apps/docs/content/6.extend/4.plugins.md
  • apps/docs/content/6.extend/5.custom-enrichers.md
  • apps/docs/content/6.extend/6.tail-sampling.md
  • apps/docs/content/6.extend/7.identity-headers.md
  • apps/docs/content/6.extend/8.custom-drains.md
  • apps/docs/content/6.extend/9.drain-pipeline.md
  • apps/docs/content/7.reference/.navigation.yml
  • apps/docs/content/7.reference/1.configuration.md
  • apps/docs/content/7.reference/2.performance.md
  • apps/docs/content/7.reference/3.vite-plugin.md
  • apps/docs/content/7.reference/4.best-practices.md
  • apps/docs/content/7.reference/5.vs-other-loggers.md
  • apps/docs/content/7.reference/6.agent-skills.md
  • apps/docs/skills/build-audit-logs/SKILL.md
  • apps/docs/test/redirects.test.ts
  • packages/evlog/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cli-section

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.

@pkg-pr-new

pkg-pr-new Bot commented Jul 26, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/@evlog/cli@451
npm i https://pkg.pr.new/evlog@451
npm i https://pkg.pr.new/@evlog/nuxthub@451
npm i https://pkg.pr.new/@evlog/telemetry@451

commit: d6623ef

@vercel
vercel Bot temporarily deployed to Preview – just-use-evlog July 26, 2026 09:54 Inactive
@vercel
vercel Bot temporarily deployed to Preview – evlog-telemetry July 26, 2026 09:54 Inactive
@HugoRCD
HugoRCD merged commit b3f0ac7 into main Jul 26, 2026
19 checks passed
@HugoRCD HugoRCD self-assigned this Jul 26, 2026
@HugoRCD
HugoRCD deleted the docs/cli-section branch July 26, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant