Skip to content

docs(analytics): screenshots, URL patterns and the restart the setup check needs - #4

Merged
danielmlr merged 1 commit into
mainfrom
docs/readme-screenshots
Sep 25, 2026
Merged

danielmlr merged 1 commit into
mainfrom
docs/readme-screenshots

Conversation

@danielmlr

Copy link
Copy Markdown
Member

Screenshots for the README and the registry listing, and two setup-check sentences corrected by what taking them found.

Screenshots

Five shots at 2x from demo data on a throwaway site made with create-emdash (blog template, EmDash 0.39.1): the dashboard widget, the Analytics page, the setup check, Analytics per entry and the editor panel. They are referenced from the README with absolute raw.githubusercontent.com URLs, so they also render on npm, and listed under release.artifacts.screenshots in the manifest (each under 1 MiB). The npm tarball does not include them.

What the demo site showed

  • The blog template's collections have no URL pattern. Every getPublicUrl() is null, so the index matches nothing. The setup check said so, but only "check that the collections have URL patterns". It now names the URL Pattern field under Content Types and Rebuild index, and the README lists URL patterns under "What you need". After setting /posts/{slug} and /pages/{slug} and rebuilding, all 8 entries matched.
  • The site URL reaches a plugin only when the server starts. The dev server was started before the setup ran, and the check reported no site URL although emdash:site_url was stored; after a restart it was there. The sentence now says a running server picks it up after a restart.

Verified

  • 288 + 13 tests, typecheck, emdash-plugin validate with the artifacts.
  • No changeset: the package is unreleased; this ships in 0.1.0.

…check needs

The README gets five screenshots from demo data on a site made from
EmDash's blog template (widget, Analytics page, setup check, per-entry
page, editor panel); the manifest lists them for the registry listing.

Taking them found two things the setup check now says:

- Collections from the blog template have no URL pattern, so no entry
  has a public URL and nothing can be matched. The index sentence names
  the URL Pattern field under Content Types and Rebuild index, and the
  README lists URL patterns under what the plugin needs.
- EmDash reads the site URL into a plugin's context when the server
  starts. A server that was already running when the setup wizard
  stored it keeps reporting none until it restarts, which the site URL
  sentence now says.
@danielmlr
danielmlr merged commit 60ee5ac into main Sep 25, 2026
2 checks passed
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.

1 participant