search

alphagov / govuk-frontend-docs

Technical documentation for GOV.UK Frontend
https://frontend.design-system.service.gov.uk/
35 stars 11 forks source link

Organise JavaScript configuration documentation #395

Closed colinrotherham closed 10 months ago

colinrotherham commented 10 months ago

We have lots of JavaScript examples split across:

This makes it difficult to add information about:

  1. Errors in the browser console
  2. Different flavours of JavaScript
  3. Benefits of using a bundler

It's hard to document ways to import JavaScript when the "importing" page is full of configuration examples

Configuration shuffle

This PR adds a new Configure components page

It was previously called Configure components with JavaScript but we now have three clear sections for:

Where the Passing JavaScript configuration section is split further into:

In the next PR I'd like to move lots of Import CSS, assets and JavaScript JavaScript examples to this new page since they're related to configuration rather than importing

This gives us more freedom to use the Import CSS, assets and JavaScript for different import flavours

netlify[bot] commented 10 months ago

Deploy Preview for govuk-frontend-docs-preview ready!

Name Link
Latest commit 1a8e35e15ddf93437d8ad01ee7632b3d1b7cbca8
Latest deploy log https://app.netlify.com/sites/govuk-frontend-docs-preview/deploys/657300913f0b620008dc050c
Deploy Preview https://deploy-preview-395--govuk-frontend-docs-preview.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.