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.

Sign up for GitHub

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

Jump to bottom

Update JavaScript API Reference for v5 #402

Merged
merged 5 commits into from
Dec 8, 2023
Merged

Update JavaScript API Reference for v5 #402

merged 5 commits into from
Dec 8, 2023

Conversation

colinrotherham
Copy link
Contributor

@colinrotherham colinrotherham commented Dec 8, 2023 •
edited
Loading

This PR simplifies the "JavaScript API Reference" introduction by:

  1. Clearly linking to the new "Configure components" page
  2. Matching config wording to "Configure components" headings
  3. Adding anchor links to each component by name
  4. Removing the Button example

Regarding 4) we have better CharacterCount examples on "Configure components" already

Configuration objects or options

I've also clarified a few mix-ups between "configuration" and "options" such as:

- Read the JavaScript API Reference for the configuration accepted by each component.
+ Read the JavaScript API Reference for the list of options in each component configuration.
- Read the JavaScript API Reference for the configuration accepted by `initAll`.
+ Read the JavaScript API Reference for the list of components in the `initAll` configuration.

@colinrotherham colinrotherham added the documentation Improvements or additions to documentation label Dec 8, 2023
@colinrotherham colinrotherham changed the base branch from main to v5-content-placeholder December 8, 2023 13:13
@netlify Netlify
Copy link

netlify bot commented Dec 8, 2023 •
edited
Loading

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

Name Link
🔨 Latest commit 99ded26
🔍 Latest deploy log https://app.netlify.com/sites/govuk-frontend-docs-preview/deploys/65731dee41d5ac0008ef6500
😎 Deploy Preview https://deploy-preview-402--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.

romaricpascal
romaricpascal approved these changes Dec 8, 2023
View reviewed changes
Copy link
Member

@romaricpascal romaricpascal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating! ⛵

@colinrotherham colinrotherham merged commit 63ebcc5 into v5-content-placeholder Dec 8, 2023
4 checks passed
@colinrotherham colinrotherham deleted the javascript-api-reference branch December 8, 2023 13:57
@colinrotherham colinrotherham mentioned this pull request Dec 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@romaricpascal romaricpascal romaricpascal approved these changes

@claireashworth claireashworth claireashworth approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@colinrotherham @romaricpascal @claireashworth