Improve Vue Documentation Quality, Accuracy, and Accessibility#3347
Open
poria-lang wants to merge 2 commits intovuejs:mainfrom
Open
Improve Vue Documentation Quality, Accuracy, and Accessibility#3347poria-lang wants to merge 2 commits intovuejs:mainfrom
poria-lang wants to merge 2 commits intovuejs:mainfrom
Conversation
This commit addresses several tasks to improve the Vue documentation:
1. Task 1: API Consistency & Updates
- Added missing Options API examples for Computed/Watcher debugging in `reactivity-in-depth.md`.
- Updated `options-state.md` with Vue 3.4+ `previous` argument in computed getters.
- Harmonized `objectOfAttrs` examples in `template-syntax.md`.
2. Task 2: Accessibility & UX
- Improved alt text for diagrams in `slots.md`, `provide-inject.md`, `template-syntax.md`, `lifecycle.md`, and `component-basics.md`.
- Removed redundant "Note" labels from callout blocks across multiple files for better clarity.
3. Task 3: Link & Reference Integrity
- Resolved `TODO`s in `routing.md`.
- Added a new "Backend Framework Integrations" section in `tooling.md`.
4. Task 4: Translation/Localization
- Replaced idiomatic expressions ("gotchas", "under the hood", "get a taste of") with global technical English ("pitfalls", "internally", "explore") in several high-traffic pages.
Verified with `vue-tsc` and visual inspection via Playwright.
Co-authored-by: poria-lang <216370060+poria-lang@users.noreply.github.com>
…0218790299783930 Improve Vue Documentation Quality, Accuracy, and Accessibility
✅ Deploy Preview for vuejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improved Vue documentation by ensuring API consistency, enhancing accessibility with better alt text, cleaning up UX callouts, resolving TODOs, and localizing idiomatic expressions for better translatability.