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

Dev documentation: update title tag props comment or description to explain its usage #1300

Closed
4 of 5 tasks
daine opened this issue Dec 16, 2024 · 1 comment
Closed
4 of 5 tasks
Assignees
Labels
Blocked Issue is blocked by another issue, please add the blocking issue number in the comments development Development tasks Low Priority | Faible priorité New | Nouveau New card, needs to be groomed

Comments

@daine
Copy link
Collaborator

daine commented Dec 16, 2024

📇 User story

As a developer I want to know what the notice-title-tag and card-title-tag properties actually do so that I can use them effectively

✅ Definition of Done / Outcomes

  • Done when it is clear that the notice-title-tag and card-title-tag properties only set the title tag to a different heading level for semantic / accessibility purposes, so that it appears in the correct order in the accessibility tree. It does not change the visual appearance of the title tag itself.

📜 Acceptance criteria

  • Comments in the stencil prop have been updated
  • README on the components affected have been updated (this should be auto generated)
  • The documentation website guidance on the code mentions this clearly
  • Check if this behaviour exists for any other component or property apart from the Notice and Card components
@daine daine added the New | Nouveau New card, needs to be groomed label Dec 16, 2024
@melaniebmn melaniebmn self-assigned this Feb 4, 2025
@melaniebmn
Copy link

Component descriptions were done in this PR. Documentation site changes were done in this PR.

Currently blocked by translation for the new documentation site content.

@melaniebmn melaniebmn added the Blocked Issue is blocked by another issue, please add the blocking issue number in the comments label Feb 4, 2025
@adorayi adorayi closed this as completed Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocked Issue is blocked by another issue, please add the blocking issue number in the comments development Development tasks Low Priority | Faible priorité New | Nouveau New card, needs to be groomed
Projects
None yet
Development

No branches or pull requests

3 participants