docs: unified framework integrations section#147
Merged
Conversation
Replace fragmented installation page + examples section with a single 2.frameworks/ hub. Each of the 13 frameworks gets a self-contained page with quick start, wide events, error handling, drain & enrichers, and framework-specific sections. - Create 2.frameworks/ with index + 13 framework pages - Slim installation.md from 1445 to ~100 lines - Delete 6.examples/ (content absorbed into framework pages) - Renumber directories (core-concepts→3, adapters→4, enrichers→5, nuxthub→6) - Add 301 redirects for /examples/* → /frameworks/* - Update all cross-references Co-Authored-By: Claude Opus 4.6 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Thank you for following the naming conventions! 🙏 |
github-actions
bot
added
the
documentation
commit: |
- Add color: neutral to all framework cards (overview + installation) - Zero-pad file prefixes (01-09) to fix lexicographic sidebar ordering - Add missing TanStack Start card to installation page - Fix /frameworks link to /frameworks/overview Co-Authored-By: Claude Opus 4.6 <[email protected]>
- Replace installation.md section + 6.examples/ page with single
2.frameworks/{NN}.{framework}.md page
- Add step for overview + installation card updates
- Update file paths and numbering (15 → 16 touchpoints)
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the evlog docs to consolidate framework integration guidance into a dedicated “Frameworks” section, slim down the installation page, and migrate/deprecate the former “Examples” docs area (with redirects).
Changes:
- Added
2.frameworks/with an overview page and per-framework integration guides. - Reorganized/renumbered doc sections (core concepts, adapters, enrichers, NuxtHub) and updated internal cross-links.
- Added 301 redirects for legacy
/examples/*framework pages to the new/frameworks/*routes.
Reviewed changes
Copilot reviewed 25 out of 44 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| apps/docs/nuxt.config.ts | Adds routeRules redirects from legacy /examples/* docs routes to /frameworks/*. |
| apps/docs/content/6.nuxthub/1.overview.md | Adds NuxtHub storage overview and schema/how-it-works docs. |
| apps/docs/content/6.nuxthub/2.retention.md | Adds NuxtHub retention/cleanup configuration and cron/task documentation. |
| apps/docs/content/6.nuxthub/.navigation.yml | Introduces NuxtHub section navigation title. |
| apps/docs/content/6.examples/.navigation.yml | Removes the former Examples section navigation entry. |
| apps/docs/content/5.enrichers/1.overview.md | Updates cross-link from Examples to Framework guide. |
| apps/docs/content/5.enrichers/2.built-in.md | Adds built-in enricher reference docs. |
| apps/docs/content/5.enrichers/3.custom.md | Adds custom enricher patterns and examples. |
| apps/docs/content/5.enrichers/.navigation.yml | Introduces Enrichers section navigation title. |
| apps/docs/content/4.adapters/1.overview.md | Adds adapters overview page and navigation cards. |
| apps/docs/content/4.adapters/2.axiom.md | Adds Axiom adapter docs. |
| apps/docs/content/4.adapters/3.otlp.md | Adds OTLP adapter docs. |
| apps/docs/content/4.adapters/4.posthog.md | Adds PostHog adapter docs. |
| apps/docs/content/4.adapters/5.sentry.md | Adds Sentry adapter docs. |
| apps/docs/content/4.adapters/6.better-stack.md | Adds Better Stack adapter docs. |
| apps/docs/content/4.adapters/7.custom.md | Adds custom adapter guidance (factory/batching/filtering/error handling). |
| apps/docs/content/4.adapters/8.pipeline.md | Updates pipeline page cross-link to Framework guide. |
| apps/docs/content/4.adapters/9.browser.md | Updates browser adapter page cross-link to Framework guide. |
| apps/docs/content/4.adapters/.navigation.yml | Introduces Adapters section navigation title. |
| apps/docs/content/3.core-concepts/1.wide-events.md | Adds wide events conceptual guide. |
| apps/docs/content/3.core-concepts/2.structured-errors.md | Updates cross-link from Examples to Framework guide. |
| apps/docs/content/3.core-concepts/3.best-practices.md | Updates installation link to Nuxt framework guide section. |
| apps/docs/content/3.core-concepts/4.typed-fields.md | Adds typed fields guide. |
| apps/docs/content/3.core-concepts/5.sampling.md | Adds sampling guide. |
| apps/docs/content/3.core-concepts/6.client-logging.md | Adds client logging guide. |
| apps/docs/content/3.core-concepts/.navigation.yml | Introduces Core Concepts section navigation title. |
| apps/docs/content/2.frameworks/.navigation.yml | Introduces Frameworks section navigation title. |
| apps/docs/content/2.frameworks/00.overview.md | Adds frameworks comparison table + cards. |
| apps/docs/content/2.frameworks/01.nuxt.md | Adds Nuxt integration guide. |
| apps/docs/content/2.frameworks/02.nextjs.md | Expands/updates Next.js integration guide content and configuration section. |
| apps/docs/content/2.frameworks/03.sveltekit.md | Updates SvelteKit guide formatting/quick-start. |
| apps/docs/content/2.frameworks/04.nitro.md | Adds Nitro v2/v3 guide. |
| apps/docs/content/2.frameworks/05.tanstack-start.md | Updates TanStack Start guide and adds adapter/enricher callout. |
| apps/docs/content/2.frameworks/06.nestjs.md | Updates NestJS guide formatting/quick-start and install command. |
| apps/docs/content/2.frameworks/07.express.md | Updates Express guide formatting/quick-start and examples. |
| apps/docs/content/2.frameworks/08.hono.md | Updates Hono guide formatting/quick-start and examples. |
| apps/docs/content/2.frameworks/09.fastify.md | Updates Fastify guide formatting/quick-start and install command. |
| apps/docs/content/2.frameworks/10.elysia.md | Updates Elysia guide formatting and tweaks “Source Code” card icon. |
| apps/docs/content/2.frameworks/11.cloudflare-workers.md | Adds Cloudflare Workers guide. |
| apps/docs/content/2.frameworks/12.standalone.md | Adds standalone TypeScript guide. |
| apps/docs/content/2.frameworks/13.astro.md | Adds Astro guide. |
| apps/docs/content/1.getting-started/2.installation.md | Slims installation page and replaces per-framework setup sections with a framework card grid + links. |
| apps/docs/content/0.landing.md | Updates landing page link to the new frameworks overview. |
| .agents/skills/create-framework-integration/SKILL.md | Updates internal contributor skill doc to align with the new docs structure (framework pages + overview/installation cards). |
Comments suppressed due to low confidence (2)
apps/docs/content/2.frameworks/10.elysia.md:270
- The “Source Code” card links to GitHub, but the icon is set to
i-custom-elysia, unlike the other framework pages which use the GitHub icon for this card. Consider switching this back toi-simple-icons-githubfor consistency and clearer meaning.
apps/docs/content/2.frameworks/02.nextjs.md:250 - This
createEvlog()configuration table doesn’t match the actualNextEvlogOptionstype. There is no top-levelenvironmentoption (it’s part ofenv?: Partial<EnvironmentContext>), anddrainis a function(ctx: DrainContext) => void | Promise<void>(not aDrainFunctiontype). Consider aligning this table withpackages/evlog/src/next/types.tsto avoid sending users to non-existent options.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+4
to
+13
| routeRules: { | ||
| '/examples/nextjs': { redirect: { to: '/frameworks/nextjs', statusCode: 301 } }, | ||
| '/examples/sveltekit': { redirect: { to: '/frameworks/sveltekit', statusCode: 301 } }, | ||
| '/examples/tanstack-start': { redirect: { to: '/frameworks/tanstack-start', statusCode: 301 } }, | ||
| '/examples/nestjs': { redirect: { to: '/frameworks/nestjs', statusCode: 301 } }, | ||
| '/examples/express': { redirect: { to: '/frameworks/express', statusCode: 301 } }, | ||
| '/examples/hono': { redirect: { to: '/frameworks/hono', statusCode: 301 } }, | ||
| '/examples/fastify': { redirect: { to: '/frameworks/fastify', statusCode: 301 } }, | ||
| '/examples/elysia': { redirect: { to: '/frameworks/elysia', statusCode: 301 } }, | ||
| }, |
There was a problem hiding this comment.
The PR description mentions adding 301 redirects for /examples/* → /frameworks/*, but routeRules only covers a subset of example routes and doesn’t include /examples itself. Also, these are exact-path rules; /examples/nextjs/ (trailing slash) won’t match unless Nuxt normalizes it. Consider adding redirects for the full prior surface area (at least /examples → /frameworks/overview) and handling trailing slashes (e.g., adding /** variants per route).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves EVL-112.
2.frameworks/section with an index page + 13 self-contained framework pages (Nuxt, Next.js, SvelteKit, Nitro, TanStack Start, NestJS, Express, Hono, Fastify, Elysia, Cloudflare Workers, Standalone, Astro)installation.mdfrom 1,445 → ~100 lines (install + framework card grid)6.examples/— content absorbed into framework pagescore-concepts→ 3,adapters→ 4,enrichers→ 5,nuxthub→ 6)/examples/*→/frameworks/*