Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organise JavaScript configuration documentation #395

Merged
merged 10 commits into from
Dec 8, 2023

Conversation

colinrotherham
Copy link
Contributor

@colinrotherham colinrotherham commented Dec 7, 2023

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

@colinrotherham colinrotherham added the documentation Improvements or additions to documentation label Dec 7, 2023
Copy link

netlify bot commented Dec 7, 2023

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

Name Link
🔨 Latest commit 1a8e35e
🔍 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.

Base automatically changed from frontend-supported to v5-content-placeholder December 8, 2023 11:33
@colinrotherham colinrotherham merged commit 44b165d into v5-content-placeholder Dec 8, 2023
5 checks passed
@colinrotherham colinrotherham deleted the component-config branch December 8, 2023 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants