Skip to content

refactor(docs): consume the changelog surface from @uxfront/layer-docs - #333

Closed
alexgrozav wants to merge 1 commit into
mainfrom
agent/palette/01a051e2
Closed

alexgrozav wants to merge 1 commit into
mainfrom
agent/palette/01a051e2

Conversation

@alexgrozav

Copy link
Copy Markdown
Contributor

What

apps/docs stops shipping its own changelog and consumes the one now owned by @uxfront/layer-docs (uxfront-com/uxfront#63).

Deleted:

  • app/pages/[[lang]]/changelog/index.vue
  • app/pages/[[lang]]/changelog/[slug].vue
  • app/composables/useChangelogReleaseUrl.ts
  • the readdirSync changelogRoutes list and the whole nitro:config hook in nuxt.config.ts

Added, in app/app.config.ts:

changelog: {
  releaseUrlTemplate: "{repo}/releases/tag/styleframe@{version}",
  description: "Everything new in Styleframe — recipes, engine improvements, and tooling, release by release.",
}

content.config.ts already declares the collection via defineDocsCollections(DOCS_SECTIONS, { sitemap: true, changelog: true }) — unchanged.

Why

The pages, the composable and the prerender workaround were all generic docs-site machinery living in a product app. The only genuinely styleframe-specific part — the styleframe@<version> release-tag convention — is now expressed as config, so nothing brand-shaped remains in the layer.

The deleted nitro:config hook enumerated content/changelog/*.md at config time because the Nitro crawler reads a version-numbered slug (/changelog/1.0.0) as a file extension and skips it. The layer now enqueues those routes with addPrerenderPath from the index page, so no filesystem read happens here. The hook's remaining locale-root seeding was identical to the layer's, so it goes too.

How verified

pnpm build:nodocs (11 tasks) then pnpm build:docs, both green, with the layer source linked in. Prerendered output diffed against the live site:

built live
/changelog title Changelog - styleframe same
/changelog/3.9.0 title A full component library — v3.9.0 - styleframe same
h1, badge, <time> A full component library, v3.9.0, June 14, 2026 same
release link …/releases/tag/styleframe@3.9.0 same
index release links 17 17
og:image absent present

.output/public/changelog.html plus all 17 .output/public/changelog/<version>.html present. The 1.0.0 and 2.0.0 entries keep their frontmatter releaseUrl overrides.

Gates: format:check clean, oxlint apps/docs clean, nuxt typecheck 0 errors, vitest run 3/3.

Known delta

OG images. The old pages called defineOgImage("DocsSatori", { headline: "styleframe", … }); the layer does not register nuxt-og-image, so /changelog* ships without og:image until OG support lands in the layer — same situation the header comment on app/pages/[[lang]]/docs/[section]/[...slug].vue already describes. No change needed here when it does.

Blocked on

uxfront-com/uxfront#63 must be released before this merges — it needs a @uxfront/layer-docs version carrying the changelog pages.

Drop the local changelog pages and `useChangelogReleaseUrl`, plus the
`readdirSync` route list and the `nitro:config` hook that existed only to get
version-numbered entry routes prerendered — the layer now enqueues them.

The `styleframe@<version>` release-tag convention moves to
`app.config.changelog.releaseUrlTemplate`, and the standfirst to
`app.config.changelog.description`.
@changeset-bot

changeset-bot Bot commented Aug 30, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1d506f5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented Aug 30, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
styleframe-dev Ready Ready Preview Aug 30, 2026 9:18am
styleframe-dev-storybook Ready Ready Preview Aug 30, 2026 9:18am

Request Review

@codecov

codecov Bot commented Aug 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alexgrozav

Copy link
Copy Markdown
Contributor Author

Closing during a tracker reset: the Multica issues tracking this work were deleted or cancelled, so this PR has no live owner or definition of done.

Not a judgement on the change itself — the branch is untouched and this PR can be reopened if the work is picked up again.

@alexgrozav alexgrozav closed this Aug 31, 2026

This branch was successfully deployed

2 active deployments
Preview – styleframe-dev — 1d506f5f Deployed Aug 30, 2026 by vercel[bot]
Preview – styleframe-dev-storybook — 1d506f5f Deployed Aug 30, 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.

1 participant