Skip to content

docs(config): show each example in its own section and version - #4866

Merged
thetaPC merged 1 commit into
mainfrom
docs/config-examples
Nov 20, 2026
Merged

thetaPC merged 1 commit into
mainfrom
docs/config-examples

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Issue URL: N/A

What is the current behavior?

  • The Fallbacks section shows the Overrides example, and Overrides shows Fallbacks: PerPlatformFallbackExample imports per-platform-overrides, and the reverse.
  • The v8 Config page shows the v9 examples, because it imports @site/docs/.... v8 readers are told to import IonicModule from @ionic/angular/lazy, which v8 doesn't have, under a v9 deprecation note. v8's own copies of the examples are never used.

What is the new behavior?

  • Each section imports its own example.
  • The Config page imports its examples relatively, such as ./config/_global.mdx, so each version loads the copies next to it. A version cut copies the page and its examples together, so the next version stays correct without edits.
  • v7 is archived, but it gets the same imports and _ prefix, since its old paths point at files docs: require a frontmatter description on every page #4865 renames.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@site/docs was never a deliberate choice. #2727 created the page with @site/docs in docs/ and relative imports in v6, and each version cut since has copied @site/docs forward.

Compared with a build of #4865, only the docs and v8 Config pages and their Markdown versions change.

How to test

  1. On the preview's Fallbacks section, the example returns one whole config or another (tabButtonLayout), matching the text above it. On production, it shows the accumulating animated and backButtonText example instead.
  2. The preview's Overrides section now shows the accumulating example.
  3. On the preview's v8 Config page, the Angular tabs import IonicModule from @ionic/angular, with no deprecation note. Production shows @ionic/angular/lazy.

⚠️ Merge #4875 into translation/jp before this PR and #4865 reach main. The Japanese build uses jp's Config page, which still imports the example paths these PRs rename, so it fails without it.

Stacked on #4865.

@thetaPC
thetaPC added this pull request to stack #4861 November 18, 2026 03:46
@vercel

vercel Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 19, 2026 11:58pm UTC

Request Review

@brandyscarney brandyscarney left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@thetaPC
thetaPC force-pushed the docs/config-examples branch from 298bfdf to d04cff0 Compare November 19, 2026 23:57
@thetaPC
thetaPC merged commit 9ed20c5 into main Nov 20, 2026
10 of 12 checks passed
@thetaPC
thetaPC deleted the docs/config-examples branch November 20, 2026 00:21

This branch was successfully deployed

1 active deployment
Preview — d04cff09 Deployed Nov 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants