docs: add a Role in the framework section to every module README
Each module README now says where the module sits in the dependency graph, why it is its own module, and lists use cases for application developers.
This commit is contained in:
@@ -26,6 +26,16 @@ cd sm-blog-app && curl -fsSL https://summercms.io/update | bash
|
||||
|
||||
The script lives inside this package so `//go:embed` can reach it, and a web server serves the bytes of the framework release it was built against. `sunrise.Script` returns them; `sunrise.UpdateScript` returns the same script with update mode preset, for the update URL.
|
||||
|
||||
## Role in the framework
|
||||
|
||||
A distribution leaf outside the runtime: no module imports it and the application binary does not need it. It lives in a package only so the script is embedded and versioned with the framework release it installs.
|
||||
|
||||
Use cases:
|
||||
|
||||
- Start a new application with one command on a fresh machine.
|
||||
- Update an existing application and its framework checkout to the newest release.
|
||||
- Serve the install script from the project website, pinned to a release.
|
||||
|
||||
## Features
|
||||
|
||||
- Truncation-safe: everything is a function definition and the last line is `main "$@"` (`main "$@" --update` in `sunrise.UpdateScript`), so a download cut short runs nothing.
|
||||
|
||||
Reference in New Issue
Block a user