Skip to content

chore(documentation): small improvements of docs #5265

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

leagrdv
Copy link
Contributor

@leagrdv leagrdv commented Apr 10, 2025

📄 Description

  • In the Guideline > Form labels, changed the HTML entities < to the brackets
  • Changed a for="" value to lowercase to be identical to the ID of the input it relates to
  • Made the npm packages link focusable

@leagrdv leagrdv requested review from a team as code owners April 10, 2025 09:17
@leagrdv leagrdv requested a review from alizedebray April 10, 2025 09:17
Copy link

changeset-bot bot commented Apr 10, 2025

🦋 Changeset detected

Latest commit: 99e807b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@swisspost/design-system-documentation Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@swisspost-bot
Copy link
Contributor

swisspost-bot commented Apr 10, 2025

Related Previews

@@ -13,25 +13,25 @@ Labels are crucial in ensuring accessibility in web forms, as they provide neces

## Visible Labels

Use the `<label>` element along with the `for` attribute to create a link between a `<label>` and an `<input>` field. The value of the `for` attribute must match the `id` of the corresponding `<input>` element, allowing screen readers to associate them correctly.
Use the `<label>` element along with the `for` attribute to create a link between a `<label>` and an `<input>` field. The value of the `for` attribute must match the `id` of the corresponding `<input>` element, allowing screen readers to associate them correctly.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this change necessary?

Copy link
Contributor Author

@leagrdv leagrdv Apr 17, 2025

Choose a reason for hiding this comment

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

Since it's in the code quotes, the output is &lt; and not <, and that is what it used to look like in the docs:
Capture d'écran 2025-04-17 085909

@leagrdv leagrdv requested a review from alizedebray April 17, 2025 07:13
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.

3 participants