diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index e9ad34d01..f296b6600 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -461,6 +461,13 @@ navigation: - page: Stainless vs. Fern path: ./pages/resources/stainless-comparison.mdx slug: stainless-comparison + - section: Sandbox + collapsed: true + hidden: true + contents: + - page: Test page sandbox + path: ./pages/sandbox/test-page.mdx + slug: test-page - api: Public API paginated: false api-name: mcp-tools diff --git a/fern/products/docs/pages/sandbox/test-page.mdx b/fern/products/docs/pages/sandbox/test-page.mdx new file mode 100644 index 000000000..511f0c783 --- /dev/null +++ b/fern/products/docs/pages/sandbox/test-page.mdx @@ -0,0 +1,140 @@ +--- +title: Test page sandbox +subtitle: A non-public sandbox page used for exercising components and the preview pipeline. +description: A non-public sandbox page used for exercising Fern components and the preview pipeline. +hide-toc: false +hide-feedback: true +hide-nav-links: true +--- + +This page is an internal sandbox. It exists to exercise a representative slice of Fern Docs components in a single place — useful for verifying preview deployments, theming changes, and component rendering without editing a real customer-facing page. + + + This page is hidden from the sidebar. It is reachable by direct URL only and is not linked from public navigation. + + +## Callouts + +An informational callout for drawing attention to context. +A warning callout for non-blocking risks the reader should consider. +A tip callout for non-essential suggestions that improve outcomes. +A success callout for confirming a positive outcome. +An error callout for surfacing failure conditions. + +## Code blocks + +A multi-language code block group demonstrates syntax highlighting and the language switcher: + + + ```bash title="curl" + curl -X POST https://api.example.com/v1/things \ + -H "Authorization: Bearer $TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"name": "widget", "quantity": 3}' + ``` + + ```typescript title="TypeScript" + import { ExampleClient } from "@example/sdk"; + + const client = new ExampleClient({ token: process.env.TOKEN }); + + const thing = await client.things.create({ + name: "widget", + quantity: 3, + }); + ``` + + ```python title="Python" + from example import ExampleClient + + client = ExampleClient(token=os.environ["TOKEN"]) + + thing = client.things.create(name="widget", quantity=3) + ``` + + +## Tabs + + + + Tabs let you present the same concept from multiple angles — for example, audience (beginner vs. advanced), runtime (Node vs. Browser), or workflow (CLI vs. UI). + + + Use tabs when content is logically parallel and a reader is likely to want only one variant at a time. Avoid tabs for sequential steps. + + + Avoid tabs for content that should be discoverable via search or skimming. Hidden tabs are easy to miss. + + + +## Accordion + + + + To validate component rendering, preview deployments, and CI without touching customer-facing pages. + + + No. It is marked `hidden: true` in navigation and is not linked from the sidebar. + + + Yes. This page has no dependencies and can be removed once the change it was created for has shipped. + + + +## Cards + + + + Site- and page-level configuration for a Fern Docs project. + + + The full catalog of built-in components. + + + Reference for the Markdown and MDX features Fern supports. + + + How files and folders are laid out in a Fern Docs project. + + + +## Tables + +| Component | Purpose | Common props | +| --------------- | ------------------------------------------- | ----------------------------- | +| `` | Highlight important context | `intent`, `icon`, `title` | +| `` | Show the same snippet in multiple languages | `title` (per child) | +| `` | Parallel variants of one concept | `title` (per child) | +| `` | Progressive disclosure | `title` | +| `` | Linked navigation tile | `title`, `icon`, `href` | + +## Parameter fields + + + A unique identifier used to look up the example. + + + + The maximum number of items to return in a single response. + + + + Whether to include archived items in the response. + + +## Steps + + + ### Install the SDK + Add the SDK to your project with your package manager of choice. + + ### Configure credentials + Set the `TOKEN` environment variable to a valid API token. + + ### Make a request + Call the API and inspect the response. If you receive a 401, double-check the token value and scope. + + + + This is a non-production sandbox page. Agents inspecting the docs corpus can safely ignore it — it does not document any customer-facing behavior. +