Skip to content

docs: rewrite the codebase guide for a Nuxt-only site - #5796

Merged
dimitrieh merged 1 commit into
nuxt/eleventy-teardownfrom
nuxt/codebase-guide
Sep 25, 2026
Merged

dimitrieh merged 1 commit into
nuxt/eleventy-teardownfrom
nuxt/codebase-guide

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor

Description

.claude/CLAUDE.md still described two generators: a migration status table, npm start for the Eleventy stack, a src/ directory layout, Nunjucks layouts per content type, and a rule against adding a new .njk page enforced by a test that no longer exists.

It now describes one Nuxt app, where each kind of content lives, and the two collections synced in from other repositories. The Blueprint Library gets a section of its own, since where it comes from and why it is gitignored is the least obvious thing in the tree. The attribution rule and the Icons section added on main since are kept, with the icon path moved to nuxt/assets/icons.

README.md's blueprint table named the override BLUEPRINTS_LOCAL; the variable the sync reads is FLOWFUSE_BLUEPRINTS_LOCAL.

Based on #5795, since it describes the tree that PR leaves behind, so the diff here shows only the guide. GitHub retargets it to main once that merges.

Related Issue(s)

Part of #5777

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
  • For blog PRs, an Art Request has been created (instructions)

@dimitrieh

Copy link
Copy Markdown
Contributor Author

Preview affected pages:

None. This PR only edits .claude/CLAUDE.md and README.md.

@dimitrieh dimitrieh mentioned this pull request Sep 16, 2026
5 tasks
.claude/CLAUDE.md still described the strangler-fig arrangement: two generators,
a migration-status table, `npm start` for the 11ty stack, a src/ directory
layout, Nunjucks layouts per content type, and a rule against adding a new .njk
page enforced by a test that no longer exists. All of that is gone.

What it says now: one Nuxt app, where each kind of content lives, and the two
collections synced in from other repositories. The Blueprint Library gets a
section of its own, since where it comes from and why it is gitignored here is
the least obvious thing in the tree: resolved at build time, with an
authenticated clone of the private library as the production path. The CTA
section keeps its detail but loses the Nunjucks half and points at
nuxt/lib/cta-destinations.ts, which has been the single source of that data
since before this migration finished. The attribution rule and the Icons
section are kept as they were, with the icon path moved to nuxt/assets/icons.

README's blueprint table named the override `BLUEPRINTS_LOCAL`; the variable
nuxt/lib/blueprints-sync.mjs reads is `FLOWFUSE_BLUEPRINTS_LOCAL`.
@dimitrieh

Copy link
Copy Markdown
Contributor Author

Rebuilt on top of the new #5795.

  • Kept the attribution rule and the Icons section that main added to the guide, with the icon path moved to nuxt/assets/icons.
  • The blueprints paragraph described the live branch; it now describes the authenticated clone that production uses.
  • README's blueprint table named BLUEPRINTS_LOCAL; the sync reads FLOWFUSE_BLUEPRINTS_LOCAL.

@dimitrieh
dimitrieh merged commit 063394d into nuxt/eleventy-teardown Sep 25, 2026
1 check failed
@dimitrieh
dimitrieh deleted the nuxt/codebase-guide branch September 25, 2026 19:05
@dimitrieh

Copy link
Copy Markdown
Contributor Author

Folded into #5795 as its third commit, so the guide lands together with the tree it describes. GitHub shows this as merged because its commit is now on its base branch, which is the branch of 5795; nothing has reached main.

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