Skip to content

docs-bug(COMPONENT): TITLE Suggestion to Improve Documentation Navigation and Component Package Overview #30846

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
satyam-mishra-dev opened this issue Apr 10, 2025 · 0 comments
Labels
docs This issue is related to documentation needs triage This issue needs to be triaged by the team

Comments

@satyam-mishra-dev
Copy link

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:

  1. 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.

  2. 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.

  1. 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

@satyam-mishra-dev satyam-mishra-dev added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation needs triage This issue needs to be triaged by the team
Projects
None yet
Development

No branches or pull requests

1 participant