Add hidden test sandbox page for documentation testing #5485
Add hidden test sandbox page for documentation testing
#5485fern-api[bot] wants to merge 1 commit into
Conversation
|
Requested by: Unknown |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| hidden: true | ||
| --- | ||
|
|
||
| This page is a hidden sandbox for exercising MDX rendering, component composition, and end-to-end content workflows. It is excluded from the sidebar via `hidden: true` and from search indexing via the surrounding markup. Link to it directly from tickets or test plans when you need a stable URL with predictable content. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'It is'.
| ### Register the navigation entry | ||
| Reference the new file from the relevant `docs.yml` so it builds. If the page is internal-only, set `hidden: true` and pin a stable `slug`. | ||
|
|
||
| ### Verify the URL |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Verify the URL' should use sentence-style capitalization.
| Walk the slug chain (`/learn/{product-slug}/{section-slug}/{page-slug}`) and confirm the page renders at the expected path. | ||
|
|
||
| ### Update internal links | ||
| When you rename or move the file, update every link that points at the old URL and add a redirect if the original URL was public. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'old' that become outdated
| </ParamField> | ||
|
|
||
| <ParamField path="slug" type="string"> | ||
| Override the auto-derived slug. Use this when you want a stable URL that is independent of the display title. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'that's' instead of 'that is'.
|
|
||
| Frontmatter sits at the top of every MDX file inside `---` delimiters. Fern parses it as YAML. Values become page-level settings — typed and validated against the page schema. Unknown keys are ignored, so feature flags or experimental fields can ride alongside well-known ones without breaking builds. | ||
|
|
||
| A few patterns we've found useful: |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'we'.
| ## Acceptance checklist | ||
|
|
||
| - [ ] The page builds without warnings under `fern check`. | ||
| - [ ] The page renders at `/learn/docs/test-sandbox` and is not visible in the sidebar. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
|
🌿 Preview your docs: https://fern-preview-fern-test-page-addition-1778624866.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Summary
Adds a new hidden test sandbox page at
fern/products/docs/pages/component-library/test-sandbox.mdxfor testing MDX rendering, component composition, and end-to-end content workflows.Changes
Test sandbox— substantial reference page exercising callouts, cards, accordions, steps, tabs, code blocks, and parameter fields.hidden: trueso it is excluded from the public sidebar but remains routable at/learn/docs/test-sandbox.fern/products/docs/docs.ymladjacent to the existing hiddenComponent demosentry.Why
Mirrors the existing
demo.mdxpattern in this repo so we have a stable, hidden target for:Verification
/learn/{product-slug}/...URL pattern derived fromdocs.yml.Requested by: Fern Support