astro 2.1.2 → 2.1.4

package/dist/core/errors/errors-data.js

@@ -1,44 +1,137 @@
-const defineErrors = (errs) => errs;
-const AstroErrorData = defineErrors({
+const AstroErrorData = {
+  /**
+   * @docs
+   * @kind heading
+   * @name Astro Errors
+   */
+  /**
+   * @docs
+   * @message
+   * Unknown compiler error.
+   * @see
+   * - [withastro/compiler issues list](https://astro.build/issues/compiler)
+   * @description
+   * Astro encountered an unknown error while compiling your files. In most cases, this is not your fault, but an issue in our compiler.
+   *
+   * If there isn't one already, please [create an issue](https://astro.build/issues/compiler).
+   */
   UnknownCompilerError: {
     title: "Unknown compiler error.",
     code: 1e3,
     hint: "This is almost always a problem with the Astro compiler, not your code. Please open an issue at https://astro.build/issues/compiler."
   },
+  // 1xxx and 2xxx codes are reserved for compiler errors and warnings respectively
+  /**
+   * @docs
+   * @see
+   * - [Enabling SSR in Your Project](https://docs.astro.build/en/guides/server-side-rendering/#enabling-ssr-in-your-project)
+   * - [Astro.redirect](https://docs.astro.build/en/guides/server-side-rendering/#astroredirect)
+   * @description
+   * The `Astro.redirect` function is only available when [Server-side rendering](/en/guides/server-side-rendering/) is enabled.
+   *
+   * To redirect on a static website, the [meta refresh attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta) can be used. Certain hosts also provide config-based redirects (ex: [Netlify redirects](https://docs.netlify.com/routing/redirects/)).
+   */
   StaticRedirectNotAvailable: {
     title: "`Astro.redirect` is not available in static mode.",
     code: 3001,
     message: "Redirects are only available when using `output: 'server'`. Update your Astro config if you need SSR features.",
     hint: "See https://docs.astro.build/en/guides/server-side-rendering/#enabling-ssr-in-your-project for more information on how to enable SSR."
   },
+  /**
+   * @docs
+   * @see
+   * - [Official integrations](https://docs.astro.build/en/guides/integrations-guide/#official-integrations)
+   * - [Astro.clientAddress](https://docs.astro.build/en/reference/api-reference/#astroclientaddress)
+   * @description
+   * The adapter you're using unfortunately does not support `Astro.clientAddress`.
+   */
   ClientAddressNotAvailable: {
     title: "`Astro.clientAddress` is not available in current adapter.",
     code: 3002,
     message: (adapterName) => `\`Astro.clientAddress\` is not available in the \`${adapterName}\` adapter. File an issue with the adapter to add support.`
   },
+  /**
+   * @docs
+   * @see
+   * - [Enabling SSR in Your Project](https://docs.astro.build/en/guides/server-side-rendering/#enabling-ssr-in-your-project)
+   * - [Astro.clientAddress](https://docs.astro.build/en/reference/api-reference/#astroclientaddress)
+   * @description
+   * The `Astro.clientAddress` property is only available when [Server-side rendering](https://docs.astro.build/en/guides/server-side-rendering/) is enabled.
+   *
+   * To get the user's IP address in static mode, different APIs such as [Ipify](https://www.ipify.org/) can be used in a [Client-side script](https://docs.astro.build/en/guides/client-side-scripts/) or it may be possible to get the user's IP using a serverless function hosted on your hosting provider.
+   */
   StaticClientAddressNotAvailable: {
     title: "`Astro.clientAddress` is not available in static mode.",
     code: 3003,
     message: "`Astro.clientAddress` is only available when using `output: 'server'`. Update your Astro config if you need SSR features.",
     hint: "See https://docs.astro.build/en/guides/server-side-rendering/#enabling-ssr-in-your-project for more information on how to enable SSR."
   },
+  /**
+   * @docs
+   * @see
+   * - [getStaticPaths()](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * @description
+   * A [dynamic route](https://docs.astro.build/en/core-concepts/routing/#dynamic-routes) was matched, but no corresponding path was found for the requested parameters. This is often caused by a typo in either the generated or the requested path.
+   */
   NoMatchingStaticPathFound: {
     title: "No static path found for requested path.",
     code: 3004,
     message: (pathName) => `A \`getStaticPaths()\` route pattern was matched, but no matching static path was found for requested path \`${pathName}\`.`,
     hint: (possibleRoutes) => `Possible dynamic routes being matched: ${possibleRoutes.join(", ")}.`
   },
+  /**
+   * @docs
+   * @message Route returned a `RETURNED_VALUE`. Only a Response can be returned from Astro files.
+   * @see
+   * - [Response](https://docs.astro.build/en/guides/server-side-rendering/#response)
+   * @description
+   * Only instances of [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) can be returned inside Astro files.
+   * ```astro title="pages/login.astro"
+   * ---
+   * return new Response(null, {
+   *  status: 404,
+   *  statusText: 'Not found'
+   * });
+   *
+   * // Alternatively, for redirects, Astro.redirect also returns an instance of Response
+   * return Astro.redirect('/login');
+   * ---
+   * ```
+   *
+   */
   OnlyResponseCanBeReturned: {
     title: "Invalid type returned by Astro page.",
     code: 3005,
     message: (route, returnedValue) => `Route \`${route ? route : ""}\` returned a \`${returnedValue}\`. Only a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) can be returned from Astro files.`,
     hint: "See https://docs.astro.build/en/guides/server-side-rendering/#response for more information."
   },
+  /**
+   * @docs
+   * @see
+   * - [`client:media`](https://docs.astro.build/en/reference/directives-reference/#clientmedia)
+   * @description
+   * A [media query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries) parameter is required when using the `client:media` directive.
+   *
+   * ```astro
+   * <Counter client:media="(max-width: 640px)" />
+   * ```
+   */
   MissingMediaQueryDirective: {
     title: "Missing value for `client:media` directive.",
     code: 3006,
     message: 'Media query not provided for `client:media` directive. A media query similar to `client:media="(max-width: 600px)"` must be provided'
   },
+  /**
+   * @docs
+   * @message Unable to render `COMPONENT_NAME`. There are `RENDERER_COUNT` renderer(s) configured in your `astro.config.mjs` file, but none were able to server-side render `COMPONENT_NAME`.
+   * @see
+   * - [Frameworks components](https://docs.astro.build/en/core-concepts/framework-components/)
+   * - [UI Frameworks](https://docs.astro.build/en/guides/integrations-guide/#official-integrations)
+   * @description
+   * None of the installed integrations were able to render the component you imported. Make sure to install the appropriate integration for the type of component you are trying to include in your page.
+   *
+   * For JSX / TSX files, [@astrojs/react](https://docs.astro.build/en/guides/integrations-guide/react/), [@astrojs/preact](https://docs.astro.build/en/guides/integrations-guide/preact/) or [@astrojs/solid-js](https://docs.astro.build/en/guides/integrations-guide/solid-js/) can be used. For Vue and Svelte files, the [@astrojs/vue](https://docs.astro.build/en/guides/integrations-guide/vue/) and [@astrojs/svelte](https://docs.astro.build/en/guides/integrations-guide/svelte/) integrations can be used respectively
+   */
   NoMatchingRenderer: {
     title: "No matching renderer found.",
     code: 3007,
@@ -50,48 +143,175 @@ but ${plural ? "none were." : "it was not."} able to server-side render \`${comp
 
 See https://docs.astro.build/en/core-concepts/framework-components/ for more information on how to install and configure integrations.`
   },
+  /**
+   * @docs
+   * @see
+   * - [addRenderer option](https://docs.astro.build/en/reference/integrations-reference/#addrenderer-option)
+   * - [Hydrating framework components](https://docs.astro.build/en/core-concepts/framework-components/#hydrating-interactive-components)
+   * @description
+   * Astro tried to hydrate a component on the client, but the renderer used does not provide a client entrypoint to use to hydrate.
+   *
+   */
   NoClientEntrypoint: {
     title: "No client entrypoint specified in renderer.",
     code: 3008,
     message: (componentName, clientDirective, rendererName) => `\`${componentName}\` component has a \`client:${clientDirective}\` directive, but no client entrypoint was provided by \`${rendererName}\`.`,
     hint: "See https://docs.astro.build/en/reference/integrations-reference/#addrenderer-option for more information on how to configure your renderer."
   },
+  /**
+   * @docs
+   * @see
+   * - [`client:only`](https://docs.astro.build/en/reference/directives-reference/#clientonly)
+   * @description
+   *
+   * `client:only` components are not run on the server, as such Astro does not know (and cannot guess) which renderer to use and require a hint. Like such:
+   *
+   * ```astro
+   *	<SomeReactComponent client:only="react" />
+   * ```
+   */
   NoClientOnlyHint: {
     title: "Missing hint on client:only directive.",
     code: 3009,
     message: (componentName) => `Unable to render \`${componentName}\`. When using the \`client:only\` hydration strategy, Astro needs a hint to use the correct renderer.`,
     hint: (probableRenderers) => `Did you mean to pass \`client:only="${probableRenderers}"\`? See https://docs.astro.build/en/reference/directives-reference/#clientonly for more information on client:only`
   },
+  /**
+   * @docs
+   * @see
+   * - [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * - [`params`](https://docs.astro.build/en/reference/api-reference/#params)
+   * @description
+   * The `params` property in `getStaticPaths`'s return value (an array of objects) should also be an object.
+   *
+   * ```astro title="pages/blog/[id].astro"
+   * ---
+   * export async function getStaticPaths() {
+   *	return [
+   *		{ params: { slug: "blog" } },
+   * 		{ params: { slug: "about" } }
+   * 	];
+   *}
+   *---
+   * ```
+   */
   InvalidGetStaticPathParam: {
     title: "Invalid value returned by a `getStaticPaths` path.",
     code: 3010,
     message: (paramType) => `Invalid params given to \`getStaticPaths\` path. Expected an \`object\`, got \`${paramType}\``,
     hint: "See https://docs.astro.build/en/reference/api-reference/#getstaticpaths for more information on getStaticPaths."
   },
+  /**
+   * @docs
+   * @see
+   * - [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * - [`params`](https://docs.astro.build/en/reference/api-reference/#params)
+   * @description
+   * `getStaticPaths`'s return value must be an array of objects.
+   *
+   * ```ts title="pages/blog/[id].astro"
+   * export async function getStaticPaths() {
+   *	return [ // <-- Array
+   *		{ params: { slug: "blog" } },
+   * 		{ params: { slug: "about" } }
+   * 	];
+   *}
+   * ```
+   */
   InvalidGetStaticPathsReturn: {
     title: "Invalid value returned by getStaticPaths.",
     code: 3011,
     message: (returnType) => `Invalid type returned by \`getStaticPaths\`. Expected an \`array\`, got \`${returnType}\``,
     hint: "See https://docs.astro.build/en/reference/api-reference/#getstaticpaths for more information on getStaticPaths."
   },
+  /**
+   * @docs
+   * @see
+   * - [RSS Guide](https://docs.astro.build/en/guides/rss/)
+   * @description
+   * `getStaticPaths` no longer expose an helper for generating a RSS feed. We recommend migrating to the [@astrojs/rss](https://docs.astro.build/en/guides/rss/#setting-up-astrojsrss)integration instead.
+   */
   GetStaticPathsRemovedRSSHelper: {
     title: "getStaticPaths RSS helper is not available anymore.",
     code: 3012,
     message: "The RSS helper has been removed from `getStaticPaths`. Try the new @astrojs/rss package instead.",
     hint: "See https://docs.astro.build/en/guides/rss/ for more information."
   },
+  /**
+   * @docs
+   * @see
+   * - [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * - [`params`](https://docs.astro.build/en/reference/api-reference/#params)
+   * @description
+   * Every route specified by `getStaticPaths` require a `params` property specifying the path parameters needed to match the route.
+   *
+   * For instance, the following code:
+   * ```astro title="pages/blog/[id].astro"
+   * ---
+   * export async function getStaticPaths() {
+   * 	return [
+   * 		{ params: { id: '1' } }
+   * 	];
+   * }
+   * ---
+   * ```
+   * Will create the following route: `site.com/blog/1`.
+   */
   GetStaticPathsExpectedParams: {
     title: "Missing params property on `getStaticPaths` route.",
     code: 3013,
     message: "Missing or empty required `params` property on `getStaticPaths` route.",
     hint: "See https://docs.astro.build/en/reference/api-reference/#getstaticpaths for more information on getStaticPaths."
   },
+  /**
+   * @docs
+   * @see
+   * - [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * - [`params`](https://docs.astro.build/en/reference/api-reference/#params)
+   * @description
+   * Since `params` are encoded into the URL, only certain types are supported as values.
+   *
+   * ```astro title="/route/[id].astro"
+   * ---
+   * export async function getStaticPaths() {
+   * 	return [
+   * 		{ params: { id: '1' } } // Works
+   * 		{ params: { id: 2 } } // Works
+   * 		{ params: { id: false } } // Does not work
+   * 	];
+   * }
+   * ---
+   * ```
+   *
+   * In routes using [rest parameters](https://docs.astro.build/en/core-concepts/routing/#rest-parameters), `undefined` can be used to represent a path with no parameters passed in the URL:
+   *
+   * ```astro title="/route/[...id].astro"
+   * ---
+   * export async function getStaticPaths() {
+   * 	return [
+   * 		{ params: { id: 1 } } // /route/1
+   * 		{ params: { id: 2 } } // /route/2
+   * 		{ params: { id: undefined } } // /route/
+   * 	];
+   * }
+   * ---
+   * ```
+   */
   GetStaticPathsInvalidRouteParam: {
     title: "Invalid value for `getStaticPaths` route parameter.",
     code: 3014,
     message: (key, value, valueType) => `Invalid getStaticPaths route parameter for \`${key}\`. Expected undefined, a string or a number, received \`${valueType}\` (\`${value}\`)`,
     hint: "See https://docs.astro.build/en/reference/api-reference/#getstaticpaths for more information on getStaticPaths."
   },
+  /**
+   * @docs
+   * @see
+   * - [Dynamic Routes](https://docs.astro.build/en/core-concepts/routing/#dynamic-routes)
+   * - [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
+   * - [Server-side Rendering](https://docs.astro.build/en/guides/server-side-rendering/)
+   * @description
+   * In [Static Mode](https://docs.astro.build/en/core-concepts/routing/#static-ssg-mode), all routes must be determined at build time. As such, dynamic routes must `export` a `getStaticPaths` function returning the different paths to generate.
+   */
   GetStaticPathsRequired: {
     title: "`getStaticPaths()` function required for dynamic routes.",
     code: 3015,
@@ -101,23 +321,51 @@ See https://docs.astro.build/en/core-concepts/framework-components/ for more inf
 Alternatively, set \`output: "server"\` in your Astro config file to switch to a non-static server build. This error can also occur if using \`export const prerender = true;\`.
 See https://docs.astro.build/en/guides/server-side-rendering/ for more information on non-static rendering.`
   },
+  /**
+   * @docs
+   * @see
+   * - [Named slots](https://docs.astro.build/en/core-concepts/astro-components/#named-slots)
+   * @description
+   * Certain words cannot be used for slot names due to being already used internally.
+   */
   ReservedSlotName: {
     title: "Invalid slot name.",
     code: 3016,
     message: (slotName) => `Unable to create a slot named \`${slotName}\`. \`${slotName}\` is a reserved slot name. Please update the name of this slot.`
   },
+  /**
+   * @docs
+   * @see
+   * - [Server-side Rendering](https://docs.astro.build/en/guides/server-side-rendering/)
+   * - [Adding an Adapter](https://docs.astro.build/en/guides/server-side-rendering/#adding-an-adapter)
+   * @description
+   * To use server-side rendering, an adapter needs to be installed so Astro knows how to generate the proper output for your targeted deployment platform.
+   */
   NoAdapterInstalled: {
     title: "Cannot use Server-side Rendering without an adapter.",
     code: 3017,
     message: `Cannot use \`output: 'server'\` without an adapter. Please install and configure the appropriate server adapter for your final deployment.`,
     hint: "See https://docs.astro.build/en/guides/server-side-rendering/ for more information."
   },
+  /**
+   * @docs
+   * @description
+   * No import statement was found for one of the components. If there is an import statement, make sure you are using the same identifier in both the imports and the component usage.
+   */
   NoMatchingImport: {
     title: "No import found for component.",
     code: 3018,
     message: (componentName) => `Could not render \`${componentName}\`. No matching import has been found for \`${componentName}\`.`,
     hint: "Please make sure the component is properly imported."
   },
+  /**
+   * @docs
+   * @message
+   * **Example error messages:**<br/>
+   * InvalidPrerenderExport: A `prerender` export has been detected, but its value cannot be statically analyzed.
+   * @description
+   * The `prerender` feature only supports a subset of valid JavaScript — be sure to use exactly `export const prerender = true` so that our compiler can detect this directive at build time. Variables, `let`, and `var` declarations are not supported.
+   */
   InvalidPrerenderExport: {
     title: "Invalid prerender export.",
     code: 3019,
@@ -133,35 +381,96 @@ Expected \`true\` value but got \`${suffix}\`.`;
     },
     hint: "Mutable values declared at runtime are not supported. Please make sure to use exactly `export const prerender = true`."
   },
+  /**
+   * @docs
+   * @message
+   * **Example error messages:**<br/>
+   * InvalidComponentArgs: Invalid arguments passed to `<MyAstroComponent>` component.
+   * @description
+   * Astro components cannot be rendered manually via a function call, such as `Component()` or `{items.map(Component)}`. Prefer the component syntax `<Component />` or `{items.map(item => <Component {...item} />)}`.
+   */
   InvalidComponentArgs: {
     title: "Invalid component arguments.",
     code: 3020,
     message: (name) => `Invalid arguments passed to${name ? ` <${name}>` : ""} component.`,
     hint: "Astro components cannot be rendered directly via function call, such as `Component()` or `{items.map(Component)}`."
   },
+  /**
+   * @docs
+   * @see
+   * - [Pagination](https://docs.astro.build/en/core-concepts/routing/#pagination)
+   * @description
+   * The page number parameter was not found in your filepath.
+   */
   PageNumberParamNotFound: {
     title: "Page number param not found.",
     code: 3021,
     message: (paramName) => `[paginate()] page number param \`${paramName}\` not found in your filepath.`,
     hint: "Rename your file to `[page].astro` or `[...page].astro`."
   },
+  /**
+   * @docs
+   * @see
+   * - [Assets (Experimental)](https://docs.astro.build/en/guides/assets/)
+   * - [Image component](https://docs.astro.build/en/guides/assets/#image--astroassets)
+   * - [Image component#alt](https://docs.astro.build/en/guides/assets/#alt-required)
+   * @description
+   * The `alt` property allows you to provide descriptive alt text to users of screen readers and other assistive technologies. In order to ensure your images are accessible, the `Image` component requires that an `alt` be specified.
+   *
+   * If the image is merely decorative (i.e. doesn’t contribute to the understanding of the page), set `alt=""` so that screen readers know to ignore the image.
+   */
   ImageMissingAlt: {
     title: "Missing alt property",
     code: 3022,
     message: "The alt property is required.",
     hint: "The `alt` property is important for the purpose of accessibility, without it users using screen readers or other assistive technologies won't be able to understand what your image is supposed to represent. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-alt for more information."
   },
+  /**
+   * @docs
+   * @see
+   * - [Image Service API](https://docs.astro.build/en/reference/image-service-reference/)
+   * @description
+   * There was an error while loading the configured image service. This can be caused by various factors, such as your image service not properly exporting a compatible object in its default export, or an incorrect path.
+   *
+   * If you believe that your service is properly configured and this error is wrong, please [open an issue](https://astro.build/issues/).
+   */
   InvalidImageService: {
     title: "Error while loading image service",
     code: 3023,
     message: "There was an error loading the configured image service. Please see the stack trace for more information."
   },
+  /**
+   * @docs
+   * @message
+   * Missing width and height attributes for `IMAGE_URL`. When using remote images, both dimensions are always required in order to avoid cumulative layout shift (CLS).
+   * @see
+   * - [Assets (Experimental)](https://docs.astro.build/en/guides/assets/)
+   * - [Image component#width-and-height](https://docs.astro.build/en/guides/assets/#width-and-height)
+   * @description
+   * For remote images, `width` and `height` cannot be inferred from the original file. As such, in order to avoid CLS, those two properties are always required.
+   *
+   * If your image is inside your `src` folder, you probably meant to import it instead. See [the Imports guide for more information](https://docs.astro.build/en/guides/imports/#other-assets).
+   */
   MissingImageDimension: {
     title: "Missing image dimensions",
     code: 3024,
     message: (missingDimension, imageURL) => `Missing ${missingDimension === "both" ? "width and height attributes" : `${missingDimension} attribute`} for ${imageURL}. When using remote images, both dimensions are always required in order to avoid CLS.`,
     hint: "If your image is inside your `src` folder, you probably meant to import it instead. See [the Imports guide for more information](https://docs.astro.build/en/guides/imports/#other-assets)."
   },
+  /**
+   * @docs
+   * @description
+   * The built-in image services do not currently support optimizing all image formats.
+   *
+   * For unsupported formats such as SVGs and GIFs, you may be able to use an `img` tag directly:
+   * ```astro
+   * ---
+   * import rocket from '../assets/images/rocket.svg'
+   * ---
+   *
+   * <img src={rocket.src} width={rocket.width} height={rocket.height} alt="A rocketship in space." />
+   * ```
+   */
   UnsupportedImageFormat: {
     title: "Unsupported image format",
     code: 3025,
@@ -170,90 +479,257 @@ Expected \`true\` value but got \`${suffix}\`.`;
     )} are supported for optimization.`,
     hint: "If you do not need optimization, using an `img` tag directly instead of the `Image` component might be what you're looking for."
   },
+  // No headings here, that way Vite errors are merged with Astro ones in the docs, which makes more sense to users.
+  // Vite Errors - 4xxx
+  /**
+   * @docs
+   * @see
+   * - [Vite troubleshooting guide](https://vitejs.dev/guide/troubleshooting.html)
+   * @description
+   * Vite encountered an unknown error while rendering your project. We unfortunately do not know what happened (or we would tell you!)
+   *
+   * If you can reliably cause this error to happen, we'd appreciate if you could [open an issue](https://astro.build/issues/)
+   */
   UnknownViteError: {
     title: "Unknown Vite Error.",
     code: 4e3
   },
+  /**
+   * @docs
+   * @see
+   * - [Type Imports](https://docs.astro.build/en/guides/typescript/#type-imports)
+   * @description
+   * Astro could not import the requested file. Oftentimes, this is caused by the import path being wrong (either because the file does not exist, or there is a typo in the path)
+   *
+   * This message can also appear when a type is imported without specifying that it is a [type import](https://docs.astro.build/en/guides/typescript/#type-imports).
+   */
   FailedToLoadModuleSSR: {
     title: "Could not import file.",
     code: 4001,
     message: (importName) => `Could not import \`${importName}\`.`,
     hint: "This is often caused by a typo in the import path. Please make sure the file exists."
   },
+  /**
+   * @docs
+   * @see
+   * - [Glob Patterns](https://docs.astro.build/en/guides/imports/#glob-patterns)
+   * @description
+   * Astro encountered an invalid glob pattern. This is often caused by the glob pattern not being a valid file path.
+   */
   InvalidGlob: {
     title: "Invalid glob pattern.",
     code: 4002,
     message: (globPattern) => `Invalid glob pattern: \`${globPattern}\`. Glob patterns must start with './', '../' or '/'.`,
     hint: "See https://docs.astro.build/en/guides/imports/#glob-patterns for more information on supported glob patterns."
   },
+  /**
+   * @docs
+   * @kind heading
+   * @name CSS Errors
+   */
+  // CSS Errors - 5xxx
+  /**
+   * @docs
+   * @see
+   * 	- [Styles and CSS](https://docs.astro.build/en/guides/styling/)
+   * @description
+   * Astro encountered an unknown error while parsing your CSS. Oftentimes, this is caused by a syntax error and the error message should contain more information.
+   */
   UnknownCSSError: {
     title: "Unknown CSS Error.",
     code: 5e3
   },
+  /**
+   * @docs
+   * @message
+   * **Example error messages:**<br/>
+   * CSSSyntaxError: Missed semicolon<br/>
+   * CSSSyntaxError: Unclosed string<br/>
+   * @description
+   * Astro encountered an error while parsing your CSS, due to a syntax error. This is often caused by a missing semicolon.
+   */
   CSSSyntaxError: {
     title: "CSS Syntax Error.",
     code: 5001
   },
+  /**
+   * @docs
+   * @kind heading
+   * @name Markdown Errors
+   */
+  // Markdown Errors - 6xxx
+  /**
+   * @docs
+   * @description
+   * Astro encountered an unknown error while parsing your Markdown. Oftentimes, this is caused by a syntax error and the error message should contain more information.
+   */
   UnknownMarkdownError: {
     title: "Unknown Markdown Error.",
     code: 6e3
   },
+  /**
+   * @docs
+   * @message
+   * **Example error messages:**<br/>
+   * can not read an implicit mapping pair; a colon is missed<br/>
+   * unexpected end of the stream within a double quoted scalar<br/>
+   * can not read a block mapping entry; a multiline key may not be an implicit key
+   * @description
+   * Astro encountered an error while parsing the frontmatter of your Markdown file.
+   * This is often caused by a mistake in the syntax, such as a missing colon or a missing end quote.
+   */
   MarkdownFrontmatterParseError: {
     title: "Failed to parse Markdown frontmatter.",
     code: 6001
   },
+  /**
+   * @docs
+   * @see
+   * - [Modifying frontmatter programmatically](https://docs.astro.build/en/guides/markdown-content/#modifying-frontmatter-programmatically)
+   * @description
+   * A remark or rehype plugin attempted to inject invalid frontmatter. This occurs when "astro.frontmatter" is set to `null`, `undefined`, or an invalid JSON object.
+   */
   InvalidFrontmatterInjectionError: {
     title: "Invalid frontmatter injection.",
     code: 6003,
     message: 'A remark or rehype plugin attempted to inject invalid frontmatter. Ensure "astro.frontmatter" is set to a valid JSON object that is not `null` or `undefined`.',
     hint: "See the frontmatter injection docs https://docs.astro.build/en/guides/markdown-content/#modifying-frontmatter-programmatically for more information."
   },
+  /**
+   * @docs
+   * @see
+   * - [MDX installation and usage](https://docs.astro.build/en/guides/integrations-guide/mdx/)
+   * @description
+   * Unable to find the official `@astrojs/mdx` integration. This error is raised when using MDX files without an MDX integration installed.
+   */
   MdxIntegrationMissingError: {
     title: "MDX integration missing.",
     code: 6004,
     message: (file) => `Unable to render ${file}. Ensure that the \`@astrojs/mdx\` integration is installed.`,
     hint: "See the MDX integration docs for installation and usage instructions: https://docs.astro.build/en/guides/integrations-guide/mdx/"
   },
+  // Config Errors - 7xxx
+  /**
+   * @docs
+   * @see
+   * - [Configuration Reference](https://docs.astro.build/en/reference/configuration-reference/)
+   * @description
+   * Astro encountered an unknown error loading your Astro configuration file.
+   * This is often caused by a syntax error in your config and the message should offer more information.
+   *
+   * If you can reliably cause this error to happen, we'd appreciate if you could [open an issue](https://astro.build/issues/)
+   */
   UnknownConfigError: {
     title: "Unknown configuration error.",
     code: 7e3
   },
+  /**
+   * @docs
+   * @see
+   * - [--config](https://docs.astro.build/en/reference/cli-reference/#--config-path)
+   * @description
+   * The specified configuration file using `--config` could not be found. Make sure that it exists or that the path is correct
+   */
   ConfigNotFound: {
     title: "Specified configuration file not found.",
     code: 7001,
     message: (configFile) => `Unable to resolve \`--config "${configFile}"\`. Does the file exist?`
   },
+  /**
+   * @docs
+   * @see
+   * - [Configuration reference](https://docs.astro.build/en/reference/configuration-reference/)
+   * @description
+   * Astro detected a legacy configuration option in your configuration file.
+   */
   ConfigLegacyKey: {
     title: "Legacy configuration detected.",
     code: 7002,
     message: (legacyConfigKey) => `Legacy configuration detected: \`${legacyConfigKey}\`.`,
     hint: "Please update your configuration to the new format.\nSee https://astro.build/config for more information."
   },
+  /**
+   * @docs
+   * @kind heading
+   * @name CLI Errors
+   */
+  // CLI Errors - 8xxx
+  /**
+   * @docs
+   * @description
+   * Astro encountered an unknown error while starting one of its CLI commands. The error message should contain more information.
+   *
+   * If you can reliably cause this error to happen, we'd appreciate if you could [open an issue](https://astro.build/issues/)
+   */
   UnknownCLIError: {
     title: "Unknown CLI Error.",
     code: 8e3
   },
+  /**
+   * @docs
+   * @description
+   * `astro sync` command failed to generate content collection types.
+   * @see
+   * - [Content collections documentation](https://docs.astro.build/en/guides/content-collections/)
+   */
   GenerateContentTypesError: {
     title: "Failed to generate content types.",
     code: 8001,
     message: "`astro sync` command failed to generate content collection types.",
     hint: "Check your `src/content/config.*` file for typos."
   },
+  /**
+   * @docs
+   * @kind heading
+   * @name Content Collection Errors
+   */
+  // Content Collection Errors - 9xxx
+  /**
+   * @docs
+   * @description
+   * Astro encountered an unknown error loading your content collections.
+   * This can be caused by certain errors inside your `src/content/config.ts` file or some internal errors.
+   *
+   * If you can reliably cause this error to happen, we'd appreciate if you could [open an issue](https://astro.build/issues/)
+   */
   UnknownContentCollectionError: {
     title: "Unknown Content Collection Error.",
     code: 9e3
   },
+  /**
+   * @docs
+   * @message
+   * **Example error message:**<br/>
+   * **blog** → **post.md** frontmatter does not match collection schema.<br/>
+   * "title" is required.<br/>
+   * "date" must be a valid date.
+   * @description
+   * A Markdown or MDX entry in `src/content/` does not match its collection schema.
+   * Make sure that all required fields are present, and that all fields are of the correct type.
+   * You can check against the collection schema in your `src/content/config.*` file.
+   * See the [Content collections documentation](https://docs.astro.build/en/guides/content-collections/) for more information.
+   */
   InvalidContentEntryFrontmatterError: {
     title: "Content entry frontmatter does not match schema.",
     code: 9001,
     message: (collection, entryId, error) => {
       return [
-        `${String(collection)} \u2192 ${String(entryId)} frontmatter does not match collection schema.`,
+        `**${String(collection)} \u2192 ${String(
+          entryId
+        )}** frontmatter does not match collection schema.`,
         ...error.errors.map((zodError) => zodError.message)
       ].join("\n");
     },
     hint: "See https://docs.astro.build/en/guides/content-collections/ for more information on content schemas."
   },
+  /**
+   * @docs
+   * @message `COLLECTION_NAME` → `ENTRY_ID` has an invalid slug. `slug` must be a string.
+   * @see
+   * - [The reserved entry `slug` field](https://docs.astro.build/en/guides/content-collections/)
+   * @description
+   * An entry in `src/content/` has an invalid `slug`. This field is reserved for generating entry slugs, and must be a string when present.
+   */
   InvalidContentEntrySlugError: {
     title: "Invalid content entry slug.",
     code: 9002,
@@ -264,6 +740,14 @@ Expected \`true\` value but got \`${suffix}\`.`;
     },
     hint: "See https://docs.astro.build/en/guides/content-collections/ for more on the `slug` field."
   },
+  /**
+   * @docs
+   * @message A content collection schema should not contain `slug` since it is reserved for slug generation. Remove this from your `COLLECTION_NAME` collection schema.
+   * @see
+   * - [The reserved entry `slug` field](https://docs.astro.build/en/guides/content-collections/)
+   * @description
+   * A content collection schema should not contain the `slug` field. This is reserved by Astro for generating entry slugs. Remove the `slug` field from your schema, or choose a different name.
+   */
   ContentSchemaContainsSlugError: {
     title: "Content Schema should not contain `slug`.",
     code: 9003,
@@ -272,11 +756,12 @@ Expected \`true\` value but got \`${suffix}\`.`;
     },
     hint: "See https://docs.astro.build/en/guides/content-collections/ for more on the `slug` field."
   },
+  // Generic catch-all - Only use this in extreme cases, like if there was a cosmic ray bit flip
   UnknownError: {
     title: "Unknown Error.",
     code: 99999
   }
-});
+};
 export {
   AstroErrorData
 };