docs: surface SSG support across READMEs#17
Merged
Conversation
- Top-level README: add Rendering Modes section (SPA/SSR/SSG comparison), add Static Site Generation section with Route.static example and hosting note. Update Quick Start to mention --ssg flag. - @effex/platform README: introduce SSR + SSG framing, add SSR vs. SSG decision table, add SSG Quick Start with full Route.static, entry, vite.config, output structure, and hydration examples. Add buildStaticSite + BuildStaticSiteOptions to API reference. - @effex/create-effex README: document SSG template, --ssg flag, project structure, and build commands. Closes #16 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Deploying effex with
|
| Latest commit: |
d153d3a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://15719c56.effex.pages.dev |
| Branch Preview URL: | https://docs-ssg-visibility.effex.pages.dev |
Deploying effex-api with
|
| Latest commit: |
d153d3a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://05a78fa6.effex-api.pages.dev |
| Branch Preview URL: | https://docs-ssg-visibility.effex-api.pages.dev |
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
README.mdgains a Rendering Modes section near the top (SPA/SSR/SSG comparison) and a dedicated Static Site Generation section with aRoute.staticexample@effex/platformREADME is reframed for both SSR and SSG with an explicit decision table, plus a full SSG Quick Start parallel to the existing SSR Quick Start@effex/create-effexREADME documents the SSG template,--ssgflag, project structure, and build commandsbuildStaticSiteandBuildStaticSiteOptionsadded to the platform API referenceNo code changes — pure documentation. SSG functionality already existed end-to-end (template, vite-plugin mode,
Platform.buildStaticSite); this just makes it discoverable.Test plan
Closes #16
🤖 Generated with Claude Code