You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR reorganizes the bundle README.md to follow the established documentation standards structure, improving accessibility and consistency with other component documentation.
Changes Made
Structure Reorganization
Overview: Replaced "Description" with "Overview" section and enhanced the explanation to better clarify the bundle's purpose for prototyping versus production use
Usage: Updated import code blocks with proper language syntax highlighting (bash, javascript)
Anatomy: Added new section describing the bundle's key parts:
All Spectrum Web Component element registrations
Base classes for components
Namespaced icon exports
Options: Created comprehensive section documenting different ways to use the bundle:
Component Registration for rapid prototyping
Type Imports for type checking and extension
Behaviors: Reorganized existing icon content into proper behaviors section:
Icon Handling with detailed explanation
UI Icons usage with namespace
Workflow Icons usage with namespace
Version Management considerations
Accessibility: Added new section referencing component-level accessibility guidelines
Content Improvements
Enhanced bundle description to better explain prototyping versus production use cases
Added proper code syntax highlighting to all code blocks
Improved clarity around icon namespace handling
Added version management guidance to help developers understand trade-offs
Included accessibility reference pointing to individual component documentation
Improved readability with better heading hierarchy and organization
Changed "renamed to" to "is renamed to" for consistency in icon documentation
Used "is namespaced" for workflow icons to maintain parallel structure
Maintains consistency with accordion, button, meter, progress bar, progress circle, and tooltip README files
Uses sentence case for all headings
Applies proper markdown formatting with code blocks and language tags
Ensures all examples are accessible and properly formatted
Testing
Verified all existing content is preserved
Confirmed proper markdown syntax and formatting
Checked consistency with documentation standards
Reviewed that all code blocks have appropriate language tags
Related Documentation
Follows structure outlined in Adding a Component Documentation Standards
Maintains consistency with other component README files across the Spectrum Web Components library
References PR #5663 (color-handle documentation reorganization) as a model
This reorganization makes the bundle documentation more accessible, easier to navigate, and consistent with the established documentation standards across the Spectrum Web Components library.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.
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.
Overview
This PR reorganizes the bundle README.md to follow the established documentation standards structure, improving accessibility and consistency with other component documentation.
Changes Made
Structure Reorganization
bash,javascript)Content Improvements
Documentation Standards Compliance
Testing
Related Documentation
This reorganization makes the bundle documentation more accessible, easier to navigate, and consistent with the established documentation standards across the Spectrum Web Components library.