Skip to content

docs: restructure docs with sub-navigation and improved content#246

Merged
HugoRCD merged 4 commits intomainfrom
docs/v2
Apr 4, 2026
Merged

docs: restructure docs with sub-navigation and improved content#246
HugoRCD merged 4 commits intomainfrom
docs/v2

Conversation

@HugoRCD
Copy link
Copy Markdown
Owner

@HugoRCD HugoRCD commented Apr 3, 2026

🔗 Linked issue

📚 Description

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@HugoRCD HugoRCD requested a review from Copilot April 3, 2026 19:52
@HugoRCD HugoRCD self-assigned this Apr 3, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 3, 2026
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 3, 2026

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 Apr 4, 2026 7:56am
just-use-evlog Ready Ready Preview, Comment Apr 4, 2026 7:56am

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Thank you for following the naming conventions! 🙏

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 3, 2026

npm i https://pkg.pr.new/evlog@246
npm i https://pkg.pr.new/@evlog/nuxthub@246

commit: 0171ebf

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR updates the docs site structure and content to introduce a “Logging” section, improve examples/code blocks, and adjust navigation + redirects accordingly.

Changes:

  • Added new “Logging” docs section (overview + simple logging) and updated many internal doc links to /logging/....
  • Updated the docs app header/navigation to surface “Logging” and to show content search in the header area.
  • Added/updated numerous redirects and code block annotations (e.g., filenames, “Terminal” blocks) across the docs.

Reviewed changes

Copilot reviewed 56 out of 62 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
bun.lock Records Bun lockfile metadata change (configVersion).
apps/docs/package.json Marks the docs package as ESM ("type": "module").
apps/docs/nuxt.config.ts Adds redirect rules and adjusts Nuxt Content config formatting; tweaks Studio dev sync setting.
apps/docs/content/6.nuxthub/2.retention.md Annotates terminal code blocks for consistent rendering.
apps/docs/content/6.nuxthub/1.overview.md Annotates terminal code blocks for consistent rendering.
apps/docs/content/5.enrichers/3.custom.md Adds filenames to code fences for clarity.
apps/docs/content/5.enrichers/2.built-in.md Adds filenames/labels to code fences and example blocks.
apps/docs/content/5.enrichers/1.overview.md Adds filename label to code fence.
apps/docs/content/4.adapters/9.custom.md Adds filename label to code fence.
apps/docs/content/4.adapters/8.hyperdx.md Adds filename/labels to code fences and console output blocks.
apps/docs/content/4.adapters/7.fs.md Adds filename/labels to code fences and text/terminal blocks.
apps/docs/content/4.adapters/6.better-stack.md Adds filename/labels to code fences and console output blocks.
apps/docs/content/4.adapters/5.sentry.md Adds filename/labels to code fences and console/text blocks.
apps/docs/content/4.adapters/4.posthog.md Adds filename/labels to code fences and console output blocks.
apps/docs/content/4.adapters/3.otlp.md Adds filename/labels to code fences and terminal/console blocks.
apps/docs/content/4.adapters/2.axiom.md Adds filename/labels to code fences and console blocks.
apps/docs/content/4.adapters/11.browser.md Adds filename labels and updates GitHub links casing.
apps/docs/content/4.adapters/10.pipeline.md Updates GitHub link casing.
apps/docs/content/4.adapters/1.overview.md Adds filename label to code fence and updates GitHub link casing.
apps/docs/content/3.core-concepts/7.configuration.md Updates examples/imports and changes links toward /logging/....
apps/docs/content/3.core-concepts/6.client-logging.md Reworks client logging section headings/examples and updates internal links to /logging/....
apps/docs/content/3.core-concepts/5.sampling.md Updates sampling config example and updates links to /logging/....
apps/docs/content/3.core-concepts/4.typed-fields.md Adds code fence labels and “Next Steps” section with updated links.
apps/docs/content/3.core-concepts/3.best-practices.md Adds missing imports in examples and updates “Next Steps” links to /logging/....
apps/docs/content/3.core-concepts/2.structured-errors.md Improves code-group blocks with clearer labels and imports; updates links to /logging/....
apps/docs/content/3.core-concepts/11.ai-sdk.md Updates doc links, expands examples/imports, and adjusts code fence labels.
apps/docs/content/3.core-concepts/10.vite-plugin.md Updates GitHub links and code fence labels/terminal blocks.
apps/docs/content/3.core-concepts/1.wide-events.md Major rewrite/expansion; updates many internal links to /logging/....
apps/docs/content/3.core-concepts/0.lifecycle.md Renames page/title, expands lifecycle documentation, updates links to /logging/....
apps/docs/content/2.logging/1.simple-logging.md Adds new “Simple Logging” guide.
apps/docs/content/2.logging/0.overview.md Adds new “Logging Overview” page.
apps/docs/content/2.logging/.navigation.yml Adds navigation grouping for the new Logging section.
apps/docs/content/2.frameworks/15.custom-integration.md Updates code fence labels, GitHub links, and adds “Next Steps” targeting /logging/....
apps/docs/content/2.frameworks/14.astro.md Adds terminal label and “Next Steps” links.
apps/docs/content/2.frameworks/13.standalone.md Adds code fence labels, updates GitHub link casing, adds “Next Steps”.
apps/docs/content/2.frameworks/12.cloudflare-workers.md Adds terminal label and “Next Steps”.
apps/docs/content/2.frameworks/11.react-router.md Updates GitHub links, terminal block labeling, adds “Next Steps”.
apps/docs/content/2.frameworks/10.elysia.md Updates GitHub links, adds terminal block label, adds “Next Steps”.
apps/docs/content/2.frameworks/09.fastify.md Updates GitHub links, adds terminal block label, adds “Next Steps”.
apps/docs/content/2.frameworks/08.hono.md Updates GitHub links, adds terminal block label, adds “Next Steps”.
apps/docs/content/2.frameworks/07.express.md Updates GitHub links, adds terminal label, tweaks output snippet, adds “Next Steps”.
apps/docs/content/2.frameworks/06.nestjs.md Updates GitHub links, adds terminal label, adds “Next Steps”.
apps/docs/content/2.frameworks/05.tanstack-start.md Updates internal link to client logging, terminal label, GitHub links, adds “Next Steps”.
apps/docs/content/2.frameworks/04.nitro.md Adds “Next Steps” section linking to /logging/....
apps/docs/content/2.frameworks/03.sveltekit.md Updates GitHub links, adds terminal label, adds “Next Steps”.
apps/docs/content/2.frameworks/02.nextjs.md Updates GitHub links, adds code fence labels/terminal label, adds “Next Steps”.
apps/docs/content/2.frameworks/01.nuxt.md Adds “Next Steps” section linking to /logging/....
apps/docs/content/2.frameworks/00.overview.md Updates feature links to /logging/... and corrects sampling link.
apps/docs/content/1.getting-started/4.agent-skills.md Updates “Next Steps” links to /logging/....
apps/docs/content/1.getting-started/3.quick-start.md Reworks quick start structure and updates links to /logging/....
apps/docs/content/1.getting-started/2.installation.md Updates “Next Steps” wide events link to /logging/....
apps/docs/content/1.getting-started/1.introduction.md Reworks intro narrative to the “three ways to log” framing; adds link to logging overview.
apps/docs/content/0.landing.md Updates landing links to /logging/... and adjusts multiple framework snippets.
apps/docs/app/components/features/FeatureStructuredErrors.vue Updates link target to /logging/structured-errors.
apps/docs/app/components/app/AppHeaderCenter.vue Changes nav menu items to “Logging” and swaps docs menu for a content search button.
apps/docs/app/components/app/AppHeader.vue Adds sub-navigation mode support and conditionally renders a bottom header section.
apps/docs/app/app.config.ts Enables header sub-navigation via app config.
Comments suppressed due to low confidence (1)

apps/docs/nuxt.config.ts:1

  • These redirects point users to /logging/wide-events, /logging/structured-errors, /logging/client-logging, and /logging/ai-sdk, but in this diff the corresponding pages still live under apps/docs/content/3.core-concepts/* (so they’ll still be routed as /core-concepts/... by Nuxt Content unless a path: override or file move is present elsewhere). This will likely create 404s for the new /logging/* URLs and for any updated links pointing there. Fix by either (a) moving the markdown files into apps/docs/content/2.logging/ (and keeping the redirects), or (b) adding Nuxt Content frontmatter path: /logging/<slug> to those existing core-concepts files (and ensuring the old /core-concepts/... routes redirect to the new paths).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@HugoRCD HugoRCD changed the title docs: improve documentation docs: restructure docs with sub-navigation and improved content Apr 4, 2026
@HugoRCD HugoRCD merged commit d3383d5 into main Apr 4, 2026
13 of 14 checks passed
@HugoRCD HugoRCD deleted the docs/v2 branch April 4, 2026 07:55
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.

2 participants