Skip to content

docs: promote @evlog/cli across skills and onboarding - #455

Merged
HugoRCD merged 2 commits into
mainfrom
docs/promote-cli-invite
Jul 26, 2026
Merged

docs: promote @evlog/cli across skills and onboarding#455
HugoRCD merged 2 commits into
mainfrom
docs/promote-cli-invite

Conversation

@HugoRCD

@HugoRCD HugoRCD commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • Invite trying @evlog/cli / evlog map from public agent skills, Start/Integrate docs, and READMEs — soft sell (npx/dlx), not a required install
  • Wire review-logging-patterns (+ siblings) and agent-skills prompts so agents can score coverage when the user is open to it
  • Add MapRulesMatrix animation on the CLI rules page (requirements vs opportunities, disable → n/a)

Test plan

  • Skim Start → Installation callout and Integrate overview for tone (invite, early, separate package)
  • Confirm review-logging-patterns still works without the CLI (manual checklist path)
  • Open /cli/rules and check MapRulesMatrix plays, respects reduced motion, no layout shift
  • Agent-skills page shows the “Raise my evlog map score” prompt

Summary by CodeRabbit

  • New Features

    • Added an animated rules matrix to visualize scan-time verdicts, disabled rules, and reduced-motion behavior.
    • Added guidance for using evlog map to score coverage and identify dark entry points.
    • Added optional CLI examples for mapping and diagnostics, including npx and pnpm dlx usage.
  • Documentation

    • Expanded CLI, integration, installation, quick-start, and agent skill documentation.
    • Added rule guidance, coverage workflows, review recommendations, and troubleshooting steps.

@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 7:13pm
evlog-telemetry Ready Ready Preview, Comment Jul 26, 2026 7:13pm
just-use-evlog Ready Ready Preview, Comment Jul 26, 2026 7:13pm

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: 20 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: 8ce77915-cd29-4a46-865f-b975f5dabaf8

📥 Commits

Reviewing files that changed from the base of the PR and between 2d597dd and e1a0d13.

📒 Files selected for processing (7)
  • apps/docs/app/components/content/MapRulesMatrix.vue
  • apps/docs/content/7.reference/6.agent-skills.md
  • apps/docs/skills/analyze-logs/SKILL.md
  • apps/docs/skills/build-audit-logs/SKILL.md
  • apps/docs/skills/review-logging-patterns/SKILL.md
  • apps/docs/skills/review-logging-patterns/references/code-review.md
  • packages/evlog/README.md
📝 Walkthrough

Walkthrough

Adds an animated rules matrix to the CLI rules documentation and expands evlog map guidance across onboarding, package READMEs, integration docs, and agent skills.

Changes

Evlog map coverage experience

Layer / File(s) Summary
Animated rules matrix
apps/docs/app/components/content/MapRulesMatrix.vue, apps/docs/content/3.cli/2.rules.md
Adds an animated requirements/opportunities matrix with timed states, reduced-motion handling, visibility-based startup, playback controls, and status indicators, then embeds it in the rules documentation.
CLI onboarding documentation
apps/docs/content/1.start/*, apps/docs/content/4.integrate/0.overview.md, packages/cli/README.md, packages/evlog/README.md
Adds or revises evlog map commands, entry-point coverage guidance, package notes, links, and usage examples.
Agent skill coverage workflows
apps/docs/content/7.reference/6.agent-skills.md, apps/docs/skills/*, apps/docs/skills/review-logging-patterns/*
Adds optional map and doctor workflows, coverage-scoring instructions, rule mappings, CLI fallback guidance, and an example prompt for improving map scores.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Suggested labels: feature

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, conventional, and accurately summarizes the cross-cutting docs push to promote @evlog/cli.
Description check ✅ Passed The description has a solid summary and test plan, though the linked issue section is still empty and the checklist is only partly filled.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/promote-cli-invite

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@455
npm i https://pkg.pr.new/evlog@455
npm i https://pkg.pr.new/@evlog/nuxthub@455
npm i https://pkg.pr.new/@evlog/telemetry@455

commit: e1a0d13

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 `@apps/docs/app/components/content/MapRulesMatrix.vue`:
- Line 144: Update the outer animation container identified by wrapperRef in
MapRulesMatrix.vue to define stable fixed dimensions, including a width and
height or suitable min-height that accommodates all slots. Preserve its existing
overflow, border, and background classes while adding the required sizing styles
or utility classes.
- Around line 58-71: Update the MapRulesMatrix sequence setup around
useTimedSequence so the prefers-reduced-motion preference is initialized before
configuring the sequence, then pass it via the hook’s reducedMotion option.
Remove the early reduced-motion return that bypasses the sequence, allowing
useTimedSequence to own the fast-path state while preserving the existing
animation behavior for other users.
- Line 25: Update the audit rule entry in the map rules matrix so its disableAt
value is 4, keeping the existing requirement kind and state values unchanged.

In `@packages/evlog/README.md`:
- Around line 1480-1485: Update the fenced example containing the logging
prompts to specify an appropriate language, preferably text, immediately after
its opening fence while preserving the example content.
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f5cf7cc4-af0c-44f0-b41c-321d3c4616f2

📥 Commits

Reviewing files that changed from the base of the PR and between 17b5395 and 2d597dd.

📒 Files selected for processing (13)
  • apps/docs/app/components/content/MapRulesMatrix.vue
  • apps/docs/content/1.start/1.introduction.md
  • apps/docs/content/1.start/3.installation.md
  • apps/docs/content/1.start/4.quick-start.md
  • apps/docs/content/3.cli/2.rules.md
  • apps/docs/content/4.integrate/0.overview.md
  • apps/docs/content/7.reference/6.agent-skills.md
  • apps/docs/skills/analyze-logs/SKILL.md
  • apps/docs/skills/build-audit-logs/SKILL.md
  • apps/docs/skills/review-logging-patterns/SKILL.md
  • apps/docs/skills/review-logging-patterns/references/code-review.md
  • packages/cli/README.md
  • packages/evlog/README.md

Comment thread apps/docs/app/components/content/MapRulesMatrix.vue Outdated
Comment thread apps/docs/app/components/content/MapRulesMatrix.vue Outdated
Comment thread apps/docs/app/components/content/MapRulesMatrix.vue Outdated
Comment thread apps/docs/skills/review-logging-patterns/SKILL.md
Comment thread packages/evlog/README.md Outdated
@HugoRCD HugoRCD self-assigned this Jul 26, 2026
@HugoRCD
HugoRCD merged commit a0cc5c7 into main Jul 26, 2026
19 checks passed
@HugoRCD
HugoRCD deleted the docs/promote-cli-invite branch July 26, 2026 19:37
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