Skip to content

docs: removed outdated warning and enhanced tree component documentation #325

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 1 commit into
base: main
Choose a base branch
from

Conversation

laske185
Copy link
Contributor

@laske185 laske185 commented Jun 3, 2025

This pull request refines the documentation for the Tree component in docs/30-components/tree.mdx. The changes improve clarity, update the keyboard navigation guide, and enhance the description of the component's usage and functionality.

Documentation Improvements:

  • Simplified Component Description: The description of the Tree component was rewritten for better readability and conciseness, removing the preview warning and emphasizing its hierarchical structure and expand/collapse functionality.
  • Enhanced Usage Details: The usage section was updated to provide clearer examples of where the Tree component is applicable (e.g., navigation bars, file directories). It also specifies how attributes like _label, _href, _active, and _open are used.

Keyboard Navigation Updates:

  • Revised Key Descriptions: The keyboard navigation guide was rewritten for improved clarity. It now uses clearer terminology, such as ↑ / ↓ for navigation within the same level and / for expanding/collapsing menus. Additional details include how alphanumeric keys can be used for quick navigation.

The A11y and PO reviews will only take place after all other DoD steps have been completed by the Developer:

  • Meaningful pull request title for the release notes
  • Pull request is linked to an issue and all changes relate to the issue
  • Tests to protect this code implemented (if applicable)
  • Manual test performed successfully (if applicable)
  • Documentation or migration has been updated (if applicable)

@publicuibot
Copy link

publicuibot bot commented Jun 3, 2025


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


Peter Laske seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Copy link

github-actions bot commented Jun 3, 2025

Netlify Draft Deployment
URL:
Logs:

@laske185
Copy link
Contributor Author

laske185 commented Jun 3, 2025

I have read the CLA Document and I hereby sign the CLA

@laske185 laske185 linked an issue Jun 3, 2025 that may be closed by this pull request
@laske185 laske185 requested a review from deleonio June 3, 2025 08:49
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.

Doku zum Tree finalisieren
1 participant