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

docs(components): improve link text for clarity and accessibility #3123

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mikoloism
Copy link

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

The documentation now contains more descriptive link text, improving clarity and accessibility for users.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

This commit updates the documentation to replace generic link text with more descriptive and meaningful phrases. The changes enhance clarity and improve accessibility for users, particularly those using screen readers.

  • Replaced "here" with specific descriptions in multiple sections, including references to custom providers, dependency injection, injection scopes, and modules.
  • Ensured that all hyperlinks provide clear context, making navigation more intuitive for readers.

These improvements align with best practices for documentation and contribute to a better user experience.

This commit updates the documentation to replace generic link text with more descriptive and meaningful phrases. The changes enhance clarity and improve accessibility for users, particularly those using screen readers. 

- Replaced "here" with specific descriptions in multiple sections, including references to custom providers, dependency injection, injection scopes, and modules.
- Ensured that all hyperlinks provide clear context, making navigation more intuitive for readers.

These improvements align with best practices for documentation and contribute to a better user experience.
@mikoloism
Copy link
Author

mikoloism commented Oct 28, 2024

I want to improve other pages too, am I allowed?

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.

2 participants