Skip to content

Commit 9f9bad6

Browse files
harlan-zwclaude
andcommitted
docs: improve content quality from audit
- Add answer-first opening to introduction - Fix typo: familar -> familiar - Add warning callout for module ordering - Improve StackBlitz link descriptions - Restructure troubleshooting with key facts first 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent ddb5961 commit 9f9bad6

File tree

5 files changed

+15
-12
lines changed

5 files changed

+15
-12
lines changed

docs/content/1.getting-started/0.introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ navigation:
55
title: 'Introduction'
66
---
77

8+
Nuxt SEO is a collection of Nuxt modules that handle [technical SEO](/learn/mastering-meta/getting-started/why-seo-matters) automatically, including sitemaps, robots.txt, Schema.org, and OG images. It combines 6 focused modules into one unified solution.
9+
810
## Background
911

1012
Technical SEO is tricky and boring. It requires many moving parts that need to work well together. Configuring all of these parts correctly is a challenge.
1113

12-
## Nuxt SEO
13-
14-
Nuxt SEO is the collective name of modules focused on improving your technical SEO.
14+
## Modules
1515

1616
:AllModules
1717

docs/content/1.getting-started/1.installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ See the [Using the Modules](/docs/nuxt-seo/guides/using-the-modules) guide to le
2929
If you run into any issues, check out the [Troubleshooting](/docs/nuxt-seo/getting-started/troubleshooting) guide. Below
3030
are the StackBlitz playgrounds for Nuxt SEO:
3131

32-
- [Basic](https://stackblitz.com/edit/nuxt-starter-gfrej6?file=nuxt.config.ts)
33-
- [I18n](https://stackblitz.com/edit/nuxt-starter-dh68fjqb?file=nuxt.config.ts)
34-
- [Nuxt Content](https://stackblitz.com/edit/nuxt-starter-xlkqkcqr?file=nuxt.config.ts)
32+
- [Basic Setup Example](https://stackblitz.com/edit/nuxt-starter-gfrej6?file=nuxt.config.ts)
33+
- [I18n Integration Example](https://stackblitz.com/edit/nuxt-starter-dh68fjqb?file=nuxt.config.ts)
34+
- [Nuxt Content Integration Example](https://stackblitz.com/edit/nuxt-starter-xlkqkcqr?file=nuxt.config.ts)

docs/content/1.getting-started/3.troubleshooting.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,16 @@ Yes! Nuxt SEO is designed to be flexible and work however you need it to.
2424

2525
### Why does my production build go up so much?
2626

27-
Nuxt SEO includes many features that only run on the server. These server-side features can increase the size of your
28-
production build by a few megabytes, but won't affect the performance of your site as the modules are lazy loaded.
27+
Server-side features add 2-5MB to the production build but don't affect runtime performance since modules are lazy loaded.
28+
29+
Nuxt SEO includes many features that only run on the server.
2930

3031
If the production build size is a concern, you can [disable the modules](/docs/nuxt-seo/guides/using-the-modules) you don't need.
3132

3233
If you are using Nuxt SEO in a serverless environment, you may want to keep your workers under 1mb. The module that
3334
will contribute the most to your worker size is `nuxt-og-image`.
3435

35-
If you are not using `ogImage`, you can disable it, otherwise consider using [Zero Runtime](/docs/og-image/guides/zero-runtime) mode.
36+
If you are not using `ogImage`, you can disable it, otherwise consider using [Zero Runtime](/docs/og-image/guides/zero-runtime) mode to prerender images at build time.
3637

3738
### What happened To Nuxt SEO Kit?
3839

docs/content/2.guides/0.using-the-modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: A quick guide on which features are available on activating Nuxt SE
55

66
## Introduction
77

8-
Nuxt SEO is a collection of 6 modules, while most will just work-out-of-the-box, there may be some configuration needed
8+
Nuxt SEO is a collection of 6 modules. Most work out-of-the-box, but some configuration may be needed
99
depending on your site's requirements.
1010

1111
This guide will give you a quick overview of each module and what you need to do to get started.
@@ -53,7 +53,7 @@ See [I18n Robots](/docs/robots/guides/i18n) for more information.
5353
Generate dynamic Open Graph images for your pages.
5454

5555
- Opt-in, by default, it won't do anything unless you configure it.
56-
- See the [Tutorial: Getting Familiar With Nuxt OG Image](/docs/og-image/getting-started/getting-familar-with-nuxt-og-image) docs on setting it up.
56+
- See the [Tutorial: Getting Familiar With Nuxt OG Image](/docs/og-image/getting-started/getting-familiar-with-nuxt-og-image) docs on setting it up.
5757

5858
Note: If you don't intend to generate dynamic images, it's recommended to [disable this module](/docs/nuxt-seo/guides/disabling-modules).
5959

docs/content/2.guides/2.nuxt-content.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ useSeoMeta(page.value.seo || {}) // <-- useSeoMeta
6262
</script>
6363
```
6464

65-
Due to current Nuxt Content v3 limitations, you must load the Nuxt SEO module before the content module.
65+
::warning
66+
Due to Nuxt Content v3 limitations, you must load `@nuxtjs/seo` before `@nuxt/content` in your modules array.
67+
::
6668

6769
```ts
6870
export default defineNuxtConfig({

0 commit comments

Comments
 (0)