Skip to content

fix: correct framework, env detection, and skill doc drift - #573

Merged
HugoRCD merged 1 commit into
mainfrom
EVL-242/repo-health-sweep-docs-skills
Aug 14, 2026
Merged

fix: correct framework, env detection, and skill doc drift#573
HugoRCD merged 1 commit into
mainfrom
EVL-242/repo-health-sweep-docs-skills

Conversation

@evlogai

@evlogai evlogai Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Part of the bi-weekly repo health sweep (EVL-242). Content-only fixes to docs and published skills, all confined to apps/docs (no changeset needed).

Fixes

  • 4.integrate/frameworks/00.overview.md: the overview claimed Hono exports no useLogger(), contradicting packages/evlog/src/hono/index.ts (export { useLogger }) and the Hono page itself (08.hono.md). Row and callout corrected.
  • 7.reference/1.configuration.md: the env auto-detection table listed package.json as a source and stale env vars. detectEnvironment() (packages/evlog/src/utils.ts) reads only process env: service = SERVICE_NAME, version = APP_VERSION, commitHash = COMMIT_SHA/GITHUB_SHA/VERCEL_GIT_COMMIT_SHA/CF_PAGES_COMMIT_SHA, region = VERCEL_REGION/AWS_REGION/FLY_REGION/CF_REGION. Table and intro updated to match.
  • skills/build-audit-logs/SKILL.md: the flagship withAudit() example used a curried withAudit(...)(fn) form; the real API is two-argument withAudit(options, fn) (packages/evlog/src/audit.ts). Example rewritten. The cheat-sheet already used the two-arg form, so the skill was internally inconsistent.
  • skills/review-logging-patterns/SKILL.md: the NuxtHub drain row documented a config key that does not exist (evlog.nuxthub: { retentionDays, batchSize }). @evlog/nuxthub reads evlog.retention as a duration string ('7d', d/h/m), default '7d' (packages/nuxthub/src/config.ts). Row corrected.

Checks

Content-only changes under apps/docs; no package code, exports, or tests are touched, so lint/typecheck/test are unaffected and no regression test applies.

Full sweep report with citations and the noted systemic findings (e.g. the pervasive em-dash in docs vs the AGENTS.md "never use an em dash" rule, and three as any casts in the Vite plugin) is tracked in the EVL-242 report.

Hono overview claimed no useLogger() export; evlog/hono exports it and
the Hono page documents it. The env auto-detection table listed
package.json sources and stale env vars; detectEnvironment() reads only
process env (SERVICE_NAME, APP_VERSION, COMMIT_SHA/GITHUB_SHA/VERCEL/
CF_PAGES, VERCEL/AWS/FLY/CF region). build-audit-logs showed a curried
withAudit() call; the API takes (options, fn). review-logging-patterns
listed a non-existent evlog.nuxthub retentionDays/batchSize config; the
module reads evlog.retention as a duration string.
@vercel

vercel Bot commented Aug 14, 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, v0 Aug 14, 2026 9:18am
evlog-render-lab Ready Ready Preview Aug 14, 2026 9:18am
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
evi Skipped Skipped Aug 14, 2026 9:18am
evlog-telemetry Skipped Skipped Aug 14, 2026 9:18am
just-use-evlog Skipped Skipped Aug 14, 2026 9:18am

Request Review

@evlogai
evlogai Bot requested a review from HugoRCD August 14, 2026 09:15
@github-actions github-actions Bot added the bug Something isn't working label Aug 14, 2026
@changeset-bot

changeset-bot Bot commented Aug 14, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3b131f2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@pkg-pr-new

pkg-pr-new Bot commented Aug 14, 2026

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

commit: 3b131f2

@HugoRCD
HugoRCD merged commit 6f60dde into main Aug 14, 2026
19 checks passed
@HugoRCD
HugoRCD deleted the EVL-242/repo-health-sweep-docs-skills branch August 14, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant