[Documentation] Add documentation for batch 1 components #336
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
Add docs files for: - accordion - alert - alert_dialog - aspect_ratio - avatar - badge - breadcrumb - calendar - card
This was referenced Dec 10, 2025
cirdes
approved these changes
Dec 11, 2025
cirdes
pushed a commit
that referenced
this pull request
Dec 11, 2025
* Add docs generator and button documentation
Introduce a new generator (`ruby_ui:install:docs`) that copies component
documentation files from the gem to Rails applications. Documentation
files follow the naming convention `{component}_docs.rb` and are copied
to `app/views/docs/` with the `_docs` suffix removed.
Usage:
bin/rails g ruby_ui:install:docs
bin/rails g ruby_ui:install:docs --force
Include stub classes for docs dependencies (Views::Base, Docs::Header,
Docs::VisualCodeExample, etc.) so docs files can be loaded without errors.
Rails apps can override these with full implementations.
Includes button component documentation as the first example.
* Add documentation for batch 1 components (#336)
Add docs files for:
- accordion
- alert
- alert_dialog
- aspect_ratio
- avatar
- badge
- breadcrumb
- calendar
- card
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.
Related issue
Related to #334
Description
This PR adds documentation files for the first batch of 9 components:
These documentation files are installed via
bin/rails g ruby_ui:install:docsand allow users to see component examples and usage patterns.Testing instructions
Execute the following tests with a Rails app that has ruby_ui installed:
Point your Rails app to the local ruby_ui source in Gemfile:
If you have any existing docs files, remove them to test fresh installation:
Run the docs generator:
Verify that all docs files were created:
app/views/docs/accordion.rbshould existapp/views/docs/alert.rbshould existapp/views/docs/alert_dialog.rbshould existapp/views/docs/aspect_ratio.rbshould existapp/views/docs/avatar.rbshould existapp/views/docs/badge.rbshould existapp/views/docs/breadcrumb.rbshould existapp/views/docs/calendar.rbshould existapp/views/docs/card.rbshould existRun tests in the ruby_ui repo:
bundle exec rake