docs(jump-links): enhance inline documentation #2749
Conversation
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
Enhanced inline documentation for rh-jump-links component to improve developer experience and API understanding: - Enhanced `orientation` property JSDoc with detailed descriptions of vertical vs horizontal layouts, usage guidelines for different contexts, and notes about automatic scroll controls - Enhanced `accessibleLabel` property JSDoc with semantic meaning for navigation landmark labeling, usage guidelines for screen reader users, and accessibility best practices - Enhanced default slot with comprehensive inline documentation explaining how to use rh-jump-link and rh-jump-links-list elements, common patterns, and best practices for page navigation All documentation includes design system context about layout behavior, accessibility requirements, and usage best practices. Note: Issue #2500 mentioned firstUpdated() and orientationChanged() methods, but firstUpdated() is a Lit lifecycle method (excluded by CEM) and orientationChanged() is a protected observer method. This PR documents the public API instead. Closes #2500 🤖 Generated with [Claude Code](https://claude.com/claude-code) Assisted-By: Claude <[email protected]>
|
✅ Deploy Preview for red-hat-design-system ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Size Change: +606 B (+0.24%) Total Size: 257 kB
ℹ️ View Unchanged
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
Enhanced inline documentation for
rh-jump-linkscomponent to improve developer experience and API understanding, following the documentation standards.Testing Instructions
This documentation was created with assistance from LLM tools. Reviewers MUST carefully verify the semantic meaning and design system accuracy of all new documentation.
Please check that the enhanced documentation:
Specific sections to review:
1.
orientationproperty2.
accessibleLabelproperty3. Default slot (lines 122-140)
Notes to Reviewers
Methods Not Documented
Issue #2500 mentioned
firstUpdated()andorientationChanged()methods, but:firstUpdated()is a Lit lifecycle method and should be excluded by CEMorientationChanged()is a protected observer method (marked with@observesdecorator)Per project guidelines, only public API should be documented. This PR focuses on the public properties (
orientation,accessibleLabel) and the default slot instead.Closes #2500
🤖 Generated with Claude Code