docs: add comprehensive installation and usage docs to all package READMEs#1489
Draft
docs: add comprehensive installation and usage docs to all package READMEs#1489
Conversation
|
…e docs Co-authored-by: p-m-p <[email protected]>
Copilot
AI
changed the title
[WIP] Update package readme files for installation and usage details
docs: add comprehensive installation and usage docs to all package READMEs
Mar 9, 2026
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
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.
Each package README contained only a single sentence pointing to the website. The root README lacked per-package detail. This PR expands all four to be self-contained references.
Root
README.md<bx-slider-controls>→<bs-slider-controls>(with correct closing tag)packages/slider/README.mdBoxSliderOptionsreference table (all 8 options)createCarouselSlider,createCubeSlider,createFadeSlider,createTileSlider) with their effect-specific optionsBoxSliderinstance API (next,prev,skipTo,play,pause,reset,destroy,activeIndex,length,getOption)packages/react/README.mdCarouselSlider,CubeSlider,FadeSlider,TileSlider,SliderControlsonBefore,onAfter,onPlay,onPause, …) withsliderRefusage examplepackages/components/README.md<bs-carousel>,<bs-cube>,<bs-fade>,<bs-tile>,<bs-slider-controls>unstyledattribute for opting out of built-in control stylesOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.