From 1dac4d5e7f3a1d661e246f24a1abc5877baf172f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= <seb@nuxt.com>
Date: Thu, 7 Nov 2024 18:22:52 +0100
Subject: [PATCH] docs: update

---
 .../docs/1.getting-started/3.collections.md   |  68 +++++++++-
 .../docs/3.composables/10.defineCollection.md | 116 ------------------
 .../.navigation.yml                           |   1 +
 .../1.query-collection.md                     |   0
 .../2.query-collection-navigation.md          |   0
 .../3.query-collection-item-surroundings.md   |   0
 .../4.query-collection-search-sections.md     |   0
 .../docs/4.components/0.content-renderer.md   |   2 +-
 docs/content/docs/5.deploy/1.cloudflare.md    |  14 +--
 docs/content/docs/5.deploy/2.nuxthub.md       |  37 +-----
 docs/content/docs/5.deploy/2.vercel.md        |  13 +-
 11 files changed, 86 insertions(+), 165 deletions(-)
 delete mode 100644 docs/content/docs/3.composables/10.defineCollection.md
 rename docs/content/docs/{3.composables => 3.utils}/.navigation.yml (64%)
 rename docs/content/docs/{3.composables => 3.utils}/1.query-collection.md (100%)
 rename docs/content/docs/{3.composables => 3.utils}/2.query-collection-navigation.md (100%)
 rename docs/content/docs/{3.composables => 3.utils}/3.query-collection-item-surroundings.md (100%)
 rename docs/content/docs/{3.composables => 3.utils}/4.query-collection-search-sections.md (100%)

diff --git a/docs/content/docs/1.getting-started/3.collections.md b/docs/content/docs/1.getting-started/3.collections.md
index ca23e1084..0cedf3091 100644
--- a/docs/content/docs/1.getting-started/3.collections.md
+++ b/docs/content/docs/1.getting-started/3.collections.md
@@ -34,11 +34,15 @@ export const collections = {
 }
 ```
 
+::note{to="#collection-types"}
+Learn more about the different types of collections.
+::
+
 ### Collection Schema
 
 Schemas enforce data consistency within a collection and serve as the source of truth for TypeScript types.
 
-Define a schema by adding the `schema` property to your collection by using a [`zod`](https://zod.dev) schema:
+On top of the [built-in fields](#built-in-fields), you can define a schema by adding the `schema` property to your collection by using a [`zod`](https://zod.dev) schema:
 
 ```ts [content.config.ts]
 import { defineCollection, z } from '@nuxt/content'
@@ -48,7 +52,7 @@ export const collections = {
     source: '**.md',
     type: 'page',
     // Define custom schema for docs collection
-    schema: z.object({  // Schema must be an object
+    schema: z.object({
       tags: z.array(z.string()),
       image: z.string(),
       date: z.Date()
@@ -84,7 +88,7 @@ export const collections = {
 
 ## Querying Collections
 
-Use the [`queryCollection`](/docs/composables/query-collection) util to fetch one or all items from a collection:
+Use the [`queryCollection`](/docs/utils/query-collection) util to fetch one or all items from a collection:
 
 ```vue [pages/blog.vue]
 <script setup lang="ts">
@@ -106,3 +110,61 @@ const { data: posts } = await useAsyncData('blog', () => queryCollection('blog')
 ::note{to="/api/query-collection"}
 Learn more about the available query options in our `queryCollections` API documentation.
 ::
+
+## defineCollection()
+
+The `defineCollection` function defines a collection in your content configuration. Here's its TypeScript signature:
+
+```ts
+function defineCollection(collection: Collection): DefinedCollection
+
+type Collection = {
+  // Determines how content is processed
+  type: 'page' | 'data'
+  // Specifies content location
+  source?: string | CollectionSource
+  // Zod schema for content validation and typing
+  schema?: ZodObject<T>
+}
+
+type CollectionSource = {
+  // Glob pattern for content matching
+  include: string
+  // .path prefix (only applies to 'page' type)
+  prefix?: string
+  // Glob patterns to exclude content
+  exclude?: string[]
+  // Root directory for content matching
+  cwd?: string
+  // Remote git repository URL (e.g., https://github.com/nuxt/content)
+  repository?: string
+}
+```
+
+### Collection Types
+
+The `type` parameter determines content processing:
+- `data`: For structured data files (JSON, YAML) that don't require rendering
+- `page`: For full pages with layouts and components that need rendering
+
+### Built-in Fields
+
+Every collection includes these default fields:
+
+- `_id`: Unique content identifier
+- `stem`: File path without extension (used for sorting and location)
+- `extension`: File extension
+- `meta`: Custom fields not defined in the collection schema
+
+Additional fields for `page` type collections:
+
+- `path`: Generated route path
+- `title`: Page title
+- `description`: Page description
+- `seo`: SEO metadata (to be used with Nuxt's `useSeoMeta` composable)
+- `body`: Page content parsed as AST
+- `navigation`: Page navigation configuration (for [`queryCollectionNavigation](/docs/composables/query-collection-navigation))
+
+### Returns
+
+The function returns the defined collection object.
diff --git a/docs/content/docs/3.composables/10.defineCollection.md b/docs/content/docs/3.composables/10.defineCollection.md
deleted file mode 100644
index 9ff68d6ac..000000000
--- a/docs/content/docs/3.composables/10.defineCollection.md
+++ /dev/null
@@ -1,116 +0,0 @@
----
-title: defineCollection
----
-
-## Type
-
-```ts
-function defineCollection(collection: Collection): DefinedCollection
-```
-
-## `defineCollection(collection: Collection)`{lang=ts}
-
-
-The `defineCollection` function is used to define a collection in your content configuration. It takes a single argument of type `Collection` and returns the defined collection.
-
-### Parameters
-
-- `collection`: An object of type `Collection` with the following properties:
-  - `source`: Specifying the source of collection. accepts:
-    - A string in glob patterns to define which files to include.
-    - An object
-  - `type`: The type of content in the collection. Currently, only `'page'` and `'data'` are supported.
-  - `schema`: (Optional) A Zod schema to validate and type the frontmatter of the documents in the collection.
-
-
-#### `type`
-
-The type parameter in defineCollection determines how the content will be processed and used:
-
-- `data`: For structured data that doesn't need rendering, like JSON or YAML files.
-- `page`: For rendering full pages with layouts and components.
-
-This choice affects how Nuxt Content handles and exposes the collection's content.
-
-By default Nuxt Content adds predefined fields to all collection. These fields are important for Module's internal workflow.
-
-  - `_id`: Unique Identifier for the content in collection.
-  - `stem`: Path of content file wihtout extension. (This is mainly used for sorting and locating the file)
-  - `extension`: File extension
-  - `meta`: A place that you find all custom fields that are not part of collection schema.
-
-In addition to these global fields, `page` collection have extra fields:
-
-- `path`: Generated path for the content that can be used as page route.
-- `title`: Page title.
-- `description`: Page description.
-- `seo`: Seo head meta.
-- `body`: The actual content of the page.
-- `navigation`: Navigation config of the page.
-
-#### `source`
-
-Collection source is specifying the location in which Nuxt Content can locate the content files.
-
-```ts
-type CollectionSource = {
-  // Glob pattern to match collection contents
-  path: string
-  // A prefix that will add to contents path (this will only applicable in `page` collections)
-  prefix?: string
-  // List of glob patterns that will use to ignore contents inside path
-  ignore?: string[]
-  // Absolute path to the root directory on content in which Nuxt Content will match the glob pattern
-  cwd?: string
-  // Nuxt Content can fetch contents from a remote git repository. ex: https://github.com/nuxt/content
-  repository?: string
-}
-```
-
-#### `schema`
-
-The `schema` property allows you to define a Zod schema for validating and typing the frontmatter of documents in your collection. This schema helps ensure data consistency and provides TypeScript support for your content.
-
-Here's an example of how you can use the `schema` property:
-
-```ts [content.config.ts]
-import { defineCollection, z } from '@nuxt/content'
-
-export const collections = {
-  docs: defineCollection({
-    source: '**',
-    type: 'page',
-    schema: z.object({ // Schema root should be an object!!
-      tags: z.array(z.string()),
-      image: z.string(),
-      date: z.Date()
-    })
-  })
-}
-```
-
-::callout
-Note that Nuxt Content extends your custom schema with a predefined schemas to improve querying experience. Checkout [Source type](#type) section to read more.
-::
-
-### Returns
-
-The function returns the defined collection object.
-
-## Example
-
-```ts [content.config.ts]
-import { defineCollection, z } from '@nuxt/content'
-
-const blog = defineCollection({
-  type: 'page',
-  source: 'blog/**/*.md',
-  schema: z.object({
-    date: z.string()
-  })
-})
-
-export const collection = {
-  blog
-}
-```
diff --git a/docs/content/docs/3.composables/.navigation.yml b/docs/content/docs/3.utils/.navigation.yml
similarity index 64%
rename from docs/content/docs/3.composables/.navigation.yml
rename to docs/content/docs/3.utils/.navigation.yml
index 84a19efb2..76824c3a1 100644
--- a/docs/content/docs/3.composables/.navigation.yml
+++ b/docs/content/docs/3.utils/.navigation.yml
@@ -1 +1,2 @@
 icon: i-lucide-square-function
+title: Vue Utils
diff --git a/docs/content/docs/3.composables/1.query-collection.md b/docs/content/docs/3.utils/1.query-collection.md
similarity index 100%
rename from docs/content/docs/3.composables/1.query-collection.md
rename to docs/content/docs/3.utils/1.query-collection.md
diff --git a/docs/content/docs/3.composables/2.query-collection-navigation.md b/docs/content/docs/3.utils/2.query-collection-navigation.md
similarity index 100%
rename from docs/content/docs/3.composables/2.query-collection-navigation.md
rename to docs/content/docs/3.utils/2.query-collection-navigation.md
diff --git a/docs/content/docs/3.composables/3.query-collection-item-surroundings.md b/docs/content/docs/3.utils/3.query-collection-item-surroundings.md
similarity index 100%
rename from docs/content/docs/3.composables/3.query-collection-item-surroundings.md
rename to docs/content/docs/3.utils/3.query-collection-item-surroundings.md
diff --git a/docs/content/docs/3.composables/4.query-collection-search-sections.md b/docs/content/docs/3.utils/4.query-collection-search-sections.md
similarity index 100%
rename from docs/content/docs/3.composables/4.query-collection-search-sections.md
rename to docs/content/docs/3.utils/4.query-collection-search-sections.md
diff --git a/docs/content/docs/4.components/0.content-renderer.md b/docs/content/docs/4.components/0.content-renderer.md
index 0bb8431c8..0bc9df641 100644
--- a/docs/content/docs/4.components/0.content-renderer.md
+++ b/docs/content/docs/4.components/0.content-renderer.md
@@ -3,7 +3,7 @@ title: ContentRenderer
 description: 'Takes your component from an AST to a wonderful template.'
 ---
 
-The `<ContentRenderer>` component renders a document coming from a query with [`queryCollections()`](/docs/composables/query-collection).
+The `<ContentRenderer>` component renders a document coming from a query with [`queryCollections()`](/docs/utils/query-collection).
 
 > This component works only with `pages` collections.
 
diff --git a/docs/content/docs/5.deploy/1.cloudflare.md b/docs/content/docs/5.deploy/1.cloudflare.md
index 31bde1eb8..14227d926 100644
--- a/docs/content/docs/5.deploy/1.cloudflare.md
+++ b/docs/content/docs/5.deploy/1.cloudflare.md
@@ -11,16 +11,14 @@ If you use the [Cloudflare Pages GitHub/GitLab integration][1]{target="_blank"}
 
 In order to publish your project, you need to create a Cloudflare D1 database and connect it to your project.
 
-[Learn how to create a D1 database](https://developers.cloudflare.com/d1/get-started/#2-create-a-database)
+- [Create a D1 database][d1]
+- Link it to your Cloudflare Pages project using the `DB` binding name
 
-## Database
-
-Unfortunately SQLite database is not supported in cloudflare environment and you should use another database.
-You can simply create a D1 database in cloudflare and use Content Module's D1 adapter.
-
-- Use [Nuxt Hub](/docs/deploy/nuxthub) to create, connect and manage D1 database for you.
-- Or create a D1 database from Cloudflare dashboard and connect it to you project by creating a `wrangler.toml` file in project root. [Get started with Cloudflare D1][d1]
+Redeploy your project.
 
+::tip
+Checkout the [**NuxtHub Integration**](/docs/deploy/nuxthub) to deploy your Nuxt Content project on your Cloudflare account with zero configuration and maximum performance.
+::
 
 [1]: https://developers.cloudflare.com/pages/get-started/#connect-your-git-provider-to-pages
 [d1]: https://developers.cloudflare.com/d1/get-started/
diff --git a/docs/content/docs/5.deploy/2.nuxthub.md b/docs/content/docs/5.deploy/2.nuxthub.md
index bf179a055..a475fcdbc 100644
--- a/docs/content/docs/5.deploy/2.nuxthub.md
+++ b/docs/content/docs/5.deploy/2.nuxthub.md
@@ -5,39 +5,4 @@ navigation:
   icon: i-simple-icons-nuxtdotjs
 ---
 
-Nuxt Content uses Nuxt deployment presets to adjust the build process for different hosting platforms. To deploy your Nuxt Content to Cloudflare, you can use the `cloudflare_pages`{lang="ts-type"} preset.
-
-You can do that in two ways:
-
-- By defining the `NITRO_PRESET`{lang="ts-type"} to `cloudflare_pages`{lang="ts-type"} when running the build process, like so:
-
-```bash
-NITRO_PRESET=cloudflare_pages npm run build
-```
-
-Or by updating your Nuxt configuration:
-
-```bash
-"preset": "cloudflare_pages",
-```
-
-If you use the [Cloudflare Pages GitHub/GitLab integration][1]{target="_blank"} Nuxt does not require configuration for presets.
-
-## Database
-
-Unfortunately sqlite database is not supported in cloudflare environment and you should use another database.
-You can simply create a D1 database in cloudflare and use Content Module's D1 adapter.
-
-- You can simply use [Nuxt Hub][nuxt-hub] to create, connect and manage D1 database for you.
-- Or you can create it directly create a D1 database from Cloudflare dashboard and connect it to you project by creating a `wrangler.toml` file in project root. [Get started with Cloudflare D1][d1]
-
-
-
-
-
-
-
-
-[1]: https://developers.cloudflare.com/pages/get-started/#connect-your-git-provider-to-pages
-[nuxt-hub]: https://hub.nuxt.com/docs/features/database
-[d1]: https://developers.cloudflare.com/d1/get-started/
+TODO
diff --git a/docs/content/docs/5.deploy/2.vercel.md b/docs/content/docs/5.deploy/2.vercel.md
index 71e03e745..9d67ae2ca 100644
--- a/docs/content/docs/5.deploy/2.vercel.md
+++ b/docs/content/docs/5.deploy/2.vercel.md
@@ -18,8 +18,19 @@ You can simply create a [Vercel Postgres][3] database and use Content Module's P
 
 Checkout [official documentation][4] to create a Vercel Postgress database and connect it to your Vercel project. Nuxt Content will automatically detect connection url from environment variables in production.
 
+```ts [nuxt.config.ts]
+export default defineNuxtConfig({
+  content: {
+    database: {
+      type: 'postgres',
+      url: process.env.POSTGRES_URL,
+      /* Other options for `pg` */
+    }
+  }
+})
+```
 
 [1]: https://vercel.com/docs/deployments/git
 [2]: https://vercel.com/docs/cli
 [3]: https://vercel.com/storage/postgres
-[4]: https://vercel.com/docs/storage/vercel-postgres/quickstart#quickstart
\ No newline at end of file
+[4]: https://vercel.com/docs/storage/vercel-postgres/quickstart#quickstart