-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Description
Documentation Feedback
The documentation and repository readme provide a helpful overview of the Angular component packages maintained by the Angular team. However, there are a few points that could enhance clarity and accessibility:
-
Missing Links in Package Table
The package overview table lists several Angular component packages like @angular/cdk, @angular/material, @angular/google-maps, and @angular/youtube-player, but the "Docs" column mentions "Docs" without providing clickable links to the respective documentation pages. Adding direct URLs would improve usability for developers trying to access documentation quickly. -
Quick Links Section Improvement
The Quick Links section mentions helpful resources like:
Documentation
Demos and Guides
FAQs
Contributing
StackBlitz Template
It would be more developer-friendly if these were formatted as actual links instead of plain text mentions.
- Clarification on Browser & Screen Reader Support
The current section on supported browsers and screen readers is comprehensive. However, it might help to add a last verified version or date for transparency on how recently these compatibility checks were validated.
Suggested Actions:
Update the documentation table with working links to each package’s docs.
Convert the Quick Links into a bulleted list with actual hyperlinks.
Add timestamps/version notes on browser and screen reader support.
This would help improve the onboarding experience for new users and make the documentation more navigable.
Thanks for the amazing work on Angular Components!
Affected documentation page
readme