chore(docs): document layout property (#5490)

* document layout * be more ambiguous * Update layout descriptions and SEO metadata text * Fix markdown formatting in front-matter.mdx * Fix layout options formatting in front-matter.mdx * Fix layout descriptions formatting in front-matter.mdx * fix frontmatter and rename page --------- Co-authored-by: fern-bot <[email protected]> Co-authored-by: Danny Sheridan <[email protected]> Co-authored-by: dannysheridan <[email protected]>
fern-api · Dec 26, 2024 · 192e49e · 192e49e
1 parent 335a5f4
commit 192e49e
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -452,7 +452,7 @@ navigation:
                 slug: response-snippet
           - page: Frontmatter
             icon: fa-regular fa-sliders
-            path: ./pages/fern-docs/content/front-matter.mdx
+            path: ./pages/fern-docs/content/frontmatter.mdx
           - page: Reusable Snippets
             icon: fa-regular fa-recycle
             path: ./pages/fern-docs/content/reusable-snippets.mdx
@@ -567,7 +567,7 @@ navigation:
 navbar-links:
   - type: minimal
     text: Slack community
-    url: https://join.slack.com/t/fern-community/shared_invite/zt-2q7ev4mki-mhO5anKslwRowp4oExWf4A
+    url: https://buildwithfern.com/slack
   - type: filled
     text: Book a demo
     url: https://buildwithfern.com/contact

diff --git a/.../pages/fern-docs/content/front-matter.mdx → fern/pages/fern-docs/content/frontmatter.mdx b/.../pages/fern-docs/content/front-matter.mdx → fern/pages/fern-docs/content/frontmatter.mdx
@@ -153,6 +153,10 @@ Controls the conditional rendering of the table of contents feature on the right
   <img src="./table-of-contents.png" alt="Table of contents feature" />
 </Frame>
 
+<Tip>
+  By default, Fern will center the contents of a page when the table of contents is hidden. To control the layout of the page, see the [layout documentation](#layout).
+</Tip>
+
 ## Navigation links
 
 **Name**: `hide-nav-links`<br />
@@ -199,9 +203,28 @@ logo:
 
 This field specifies the logo for this page. If no logo is set, the site-wide [logo configuration](/learn/docs/getting-started/global-configuration#logo-configuration) is used.
 
+## Layout
+
+**Name**: `layout`<br />
+**Type**: `overview`, `guide`, `reference`, `page`, or `custom`<br />
+**Default**: `guide`
+
+Sets the page layout.
+
+- `overview`: A spacious, full-width layout without a table of contents. Perfect for landing pages, section overviews, and content that benefits from maximum horizontal space. Navigation sidebar remains visible.
+
+- `guide`: The default documentation layout featuring a table of contents on the right side. Ideal for tutorials, how-to guides, and any content that benefits from easy navigation through sections.
+
+- `reference`: A full-width layout optimized for an API or SDK reference. Removes the table of contents so you can add another column, such as code examples. Navigation sidebar remains visible.
+
+- `page`: A distraction-free, full-screen layout that hides both the table of contents and navigation sidebar. Best for standalone content that benefits from focused reading experiences.
+
+- `custom`: A blank canvas layout that removes all default styling constraints. Hides both the table of contents and navigation sidebar, allowing complete control over the page layout.
+
 ## SEO metadata
 
-Fern also supports adding SEO-specific metadata in the frontmatter. 
+Fern supports adding SEO metadata in the frontmatter.
+
 
 | Property | Description | Type |
 | -------- | ----------- | ---- |