golem15/summercms
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(11.2): record site_label and pretty docs link decisions

Browse Source
This commit is contained in:
Jakub Zych
2026-10-01 15:09:12 +02:00
parent e032a65fc9
commit 5dcfc0867b
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.planning/phases/11.2-ready-to-share-summercms-io-website-and-newsletter-plugin/11.2-CONTEXT.md
View File

@@ -67,6 +67,10 @@ Out of scope: newsletter signup, the Polish locale and the subscriber admin. The
- **D-37:** SEO uses the full `@nuxtjs/seo` module, as `vue-fonoteka-app` does: meta, Open Graph and Twitter tags, OG image, schema.org, sitemap and robots. Whatever it generates must work with `nuxt generate` and be embedded (no runtime OG rendering in the Go binary). - **D-37:** SEO uses the full `@nuxtjs/seo` module, as `vue-fonoteka-app` does: meta, Open Graph and Twitter tags, OG image, schema.org, sitemap and robots. Whatever it generates must work with `nuxt generate` and be embedded (no runtime OG rendering in the Go binary).
- **D-45:** The prototype's `showRays` and `scrollSpy` flags become Nuxt app config, both defaulting to `true`. - **D-45:** The prototype's `showRays` and `scrollSpy` flags become Nuxt app config, both defaulting to `true`.
### Planning-session decisions (2026-10-01, after research)
- **D-46:** D-41 is extended. `docs/site.yaml` gets an optional `site_url` and an optional `site_label`. `summer docs:build` and `summer docs:serve` accept `--site-url` and `--site-label` flags that override them, the same way `--base-url` overrides `base_url`. The framework's own `site.yaml` sets neither, so its docs output is unchanged. If `site_label` is unset, the label is the URL's host, or "Home" for a relative URL. The summercms.io build passes `--site-url /` and `--site-label summercms.io`, so the header reads "← summercms.io".
- **D-47:** The landing page keeps the handoff's extension-less `/docs/...` hrefs exactly as written (for example `/docs/backend/admin-spa`). `sm-summercms-plugin` answers an extension-less `/docs/x` with a 301 to `/docs/x.html` when that page exists. The SC3 link check follows the redirect and requires the final 200.
### Get started accuracy ### Get started accuracy
- **D-38:** Both Source links point to `https://git.golem15.com/golem15/summercms`. The repo currently requires login, so making it public is a launch checklist item in DEPLOY.md, done manually by the user before cutover. The link check (roadmap criterion 3) verifies anonymous access at cutover time. - **D-38:** Both Source links point to `https://git.golem15.com/golem15/summercms`. The repo currently requires login, so making it public is a launch checklist item in DEPLOY.md, done manually by the user before cutover. The link check (roadmap criterion 3) verifies anonymous access at cutover time.
- **D-39:** The terminal card gets a clone step so it works when pasted into a fresh shell: a `# get the framework` comment, then `$ git clone https://git.golem15.com/golem15/summercms` and `$ cd summercms`, before the existing `go install ./cmd/summer` group. The Copy button copies every command line in order (now six), without `$` or comments. - **D-39:** The terminal card gets a clone step so it works when pasted into a fresh shell: a `# get the framework` comment, then `$ git clone https://git.golem15.com/golem15/summercms` and `$ cd summercms`, before the existing `go install ./cmd/summer` group. The Copy button copies every command line in order (now six), without `$` or comments.