Skip to content

chore: rename minimal-* example dirs, reorganize docs nav - #143

Merged
antfu merged 2 commits into
mainfrom
chore/rename-examples-and-docs-nav
Jul 28, 2026
Merged

chore: rename minimal-* example dirs, reorganize docs nav#143
antfu merged 2 commits into
mainfrom
chore/rename-examples-and-docs-nav

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Summary

  • Renames the three `minimal-*` example directories for shorter, consistent paths:
    • `examples/minimal-next-devframe-hub` → `examples/next-devframe-hub`
    • `examples/minimal-vite-devframe-hub` → `examples/vite-devframe-hub`
    • `examples/minimal-json-render` → `examples/json-render`
  • Updates every package name, workspace path (`turbo.json`, `vitest.config.ts`, `tsconfig.base.json`, `alias.ts`, the typecheck-coverage exceptions), identifier, and doc link tied to the old names, including renaming the source/test files that had the old name baked into their filename.
  • Restructures the docs top nav in `docs/.vitepress/config.ts`:
    • Plugins gets its own dedicated top-level dropdown (previously nested inside a "Resources" dropdown).
    • Helpers moves under the Adapters dropdown.
    • Examples moves under the Guide dropdown.
    • The sidebar keeps its existing separate top-level sections for each — only the top nav grouping changed.

Verification

  • `pnpm lint` — clean
  • `pnpm typecheck` — 20/20 tasks pass
  • `pnpm build` — all packages build, including both renamed hub examples
  • `pnpm test` — 84 test files / 881 tests pass
  • `pnpm --filter devframe-docs run docs:build` — VitePress build succeeds with the new nav structure and renamed example pages (no broken links)

Created with the help of an agent.

Rename examples/minimal-next-devframe-hub -> examples/next-devframe-hub,
examples/minimal-vite-devframe-hub -> examples/vite-devframe-hub, and
examples/minimal-json-render -> examples/json-render, updating every
package name, identifier, workspace path, and doc link tied to the old
names.

Restructure the docs top nav: Plugins gets its own dedicated dropdown,
Helpers moves under Adapters, and Examples moves under Guide.
@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for devfra ready!

Name Link
🔨 Latest commit f52a035
🔍 Latest deploy log https://app.netlify.com/projects/devfra/deploys/6a6874e77dccd30009d52849
😎 Deploy Preview https://deploy-preview-143--devfra.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Standardize every example's devframe id (and the RPC/command names,
scoped-context namespaces, and hub-level hand-rolled RPC/command names
derived from it) under a single example: prefix, replacing the
inconsistent devframe-* prefix (files-inspector, streaming-chat) and
bare ids (json-render, next-runtime-snapshot, and the demo devframes
mounted by the two hub examples) used before.

Mount paths, cli.command names, and the postMessage frameId protocol
stay decoupled and unprefixed, matching how basePath already worked.
@antfu
antfu merged commit 9b55cb8 into main Jul 28, 2026
12 checks passed
@antfu
antfu deleted the chore/rename-examples-and-docs-nav branch July 28, 2026 10:04
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