From b0b185b7dcb29ed8fc54d44ca7472afb08686581 Mon Sep 17 00:00:00 2001 From: chdeskur Date: Tue, 5 Aug 2025 09:08:02 -0400 Subject: [PATCH] document-landing-page-slug --- .../docs/pages/customization/what-is-docs-yml.mdx | 7 +++++++ fern/products/docs/pages/seo/configuring-slugs.mdx | 10 ++++++++++ 2 files changed, 17 insertions(+) diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index d457c924d..945a33a2a 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -504,6 +504,7 @@ The GitHub repository must be **public** for the "Edit this page" feature to wor landing-page: page: Page Title path: path/to/landing-page.mdx + slug: /welcome ``` @@ -514,6 +515,12 @@ landing-page: Relative filepath to the desired landing page Markdown file. + + The slug of the landing page. Defaults to the page name. + + The slug can also be overridden in the frontmatter of the landing page Markdown file. + + See [Vapi's landing page live](https://docs.vapi.ai/) and the associated [Markdown file](https://github.com/VapiAI/docs/blob/main/fern/quickstart/introduction.mdx?plain=1). ## Metadata configuration diff --git a/fern/products/docs/pages/seo/configuring-slugs.mdx b/fern/products/docs/pages/seo/configuring-slugs.mdx index 128ceeb23..2bf63ef4a 100644 --- a/fern/products/docs/pages/seo/configuring-slugs.mdx +++ b/fern/products/docs/pages/seo/configuring-slugs.mdx @@ -83,6 +83,16 @@ navigation: In the example above, the **Welcome** page would be hosted at `plantstore.docs.buildwithfern.com/guides/get-started/welcome`. +#### Modify a landing page's slug +To modify the slug used for a tab, you can set the `slug` within the `landing-page` object. + +```yaml title="docs.yml" {4} +landing-page: + page: Page Title + path: path/to/landing-page.mdx + slug: /welcome +``` + #### Override a page's slug You can set the exact slug of a page within its frontmatter. [You can read more about the frontmatter configuration here](/learn/docs/content/frontmatter#slug).