Skip to content

Add a Get started guide and Utilities section to the dummy app#279

Merged
FilisLiu merged 2 commits into
mainfrom
FilisLiu/dummy-app-user-guide
Jun 29, 2026
Merged

Add a Get started guide and Utilities section to the dummy app#279
FilisLiu merged 2 commits into
mainfrom
FilisLiu/dummy-app-user-guide

Conversation

@FilisLiu

@FilisLiu FilisLiu commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

What?

Turns the dummy app home page into a clear "Get started" guide and adds a new Utilities section to the preview site.

The home page now welcomes developers, shows which GOV.UK and NHS UK Frontend versions the gem is built on, links to the gem, repository and changelog, and points to the site's three sections. The live JavaScript demos (Stimulus controllers and time ago) have moved off the home page into the new Utilities section.

Why?

Our users are NHS and GOVUK developers who currently hand-build services in HTML and Bootstrap. The home page used to be a sandbox of loose demos, which did little to help a newcomer understand what the gem offers or how to find it.

The guide speaks to that audience and gets them productive by orienting them around the app itself, using the same Styles / Components / Utilities vocabulary the design systems already use. It also makes the bundled frontend versions and the key links (gem, repo, changelog) easy to find.

How?

  • Rewrote pages/index.html.erb as an orientation guide: lead intro, a "What's included" version summary, a "How this site is organised" map of the sections, and a "How to use the examples" note. All built from ds_ helpers.
  • Added a frontend_version helper that reads the bundled GOV.UK / NHS UK Frontend versions from the gem's stylesheet directory names, so they stay accurate when frontends are updated rather than being hard-coded.
  • Added a Utilities section (UtilitiesController, route, index, sidebar) mirroring the existing Styles and Components sections, with the Stimulus controllers and time ago demos rendered through the standard component_preview (ERB input + rendered/HTML output).
  • Added Utilities to the home page sidebar and locale entries for the new preview headings.
  • Corrected the stale frontend versions in the README (5.9.0 → 5.11.1, 9.3.0 → 10.3.1) and updated the changelog.

Testing?

  • bin/rails test — 318 runs, 0 failures.
  • bin/rubocop — no new offenses introduced by this change.
  • Manually verified in the browser, both brands: home page, Utilities index, and both utility pages render; the Stimulus "Greet" demo and the time ago helper still work; no console errors.

Screenshots?

image

FilisLiu and others added 2 commits June 26, 2026 16:59
Rework the dummy app home page into an orientation guide that maps the
site around its own Styles / Components / Utilities sections, shows the
bundled GOV.UK and NHS UK Frontend versions, and links to the gem,
repository and changelog.

Move the live JavaScript demos (Stimulus controllers and time ago) off
the home page into a new Utilities section that mirrors the Styles and
Components pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@FilisLiu FilisLiu requested a review from timgentry June 29, 2026 13:23
@FilisLiu FilisLiu self-assigned this Jun 29, 2026
@FilisLiu FilisLiu merged commit 536848a into main Jun 29, 2026
2 of 4 checks passed
@FilisLiu FilisLiu deleted the FilisLiu/dummy-app-user-guide branch June 29, 2026 13:54
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.

2 participants