docs: add Project Structure guide page - #290
Open
antfubot wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a new guide page — Project Structure — documenting the recommended folder layout for a devframe package, distilled from reading through all the built-in plugins, the examples, and the
starter/template.The page maps the shared convention: one
defineDevframefactory drives every surface, so the layout's job is to keep the node and browser sides in separate module graphs and expose each seam (src/index.tsfactory,src/node/setup,src/rpc/registry,src/client/connect helper,src/spa/UI, sibling--assetspackage,cli.ts+bin.mjs) through its own package subpath. It covers the tsdown dual-graph build, mount-path-portable SPA (base: './'), and the optional pieces (inject/,shared/,diagnostics.ts, playgrounds, tests).Why
There was no single page describing how to lay out a devframe package end to end; authors had to reverse-engineer it from the plugins. This gives a canonical reference right after the Devframe Definition page.
Notes
[filename]code fences).This PR was created with the help of an agent.