Skip to content

Conversation

@djalmaaraujo
Copy link
Contributor

Related Issue

Continues from #337 (batch 4 documentation)

Description

Adds documentation files for the final batch of components:

  • Skeleton - Placeholder while content is loading
  • Switch - Toggle control for checked/unchecked states
  • Table - Responsive table component with caption, header, body, and footer
  • Tabs - Layered sections of content displayed one at a time
  • Textarea - Multi-line text input field
  • ThemeToggle - Toggle between dark/light theme modes
  • Tooltip - Popup displaying information on hover/focus
  • Typography - Sensible defaults for headings, text, links, and lists

Also adds missing stub methods required by typography documentation:

  • Components.Heading - Module-level heading method
  • Components.TypographyList - Typography list component
  • InlineCode - Inline code block helper
  • docs_installation_path - Route helper stub

Testing Instructions

  1. Add to your Rails app's Gemfile:

    gem "ruby_ui", path: "../ruby_ui"
  2. Remove any existing doc files that may conflict:

    rm -f app/views/docs/skeleton.rb
    rm -f app/views/docs/switch.rb
    rm -f app/views/docs/table.rb
    rm -f app/views/docs/tabs.rb
    rm -f app/views/docs/textarea.rb
    rm -f app/views/docs/theme_toggle.rb
    rm -f app/views/docs/tooltip.rb
    rm -f app/views/docs/typography.rb
  3. Run the docs generator:

    bin/rails g ruby_ui:install:docs
  4. Verify files were created:

    ls app/views/docs/skeleton.rb
    ls app/views/docs/switch.rb
    ls app/views/docs/table.rb
    ls app/views/docs/tabs.rb
    ls app/views/docs/textarea.rb
    ls app/views/docs/theme_toggle.rb
    ls app/views/docs/tooltip.rb
    ls app/views/docs/typography.rb
  5. Run the test suite:

    bundle exec rake

Add documentation files for skeleton, switch, table, tabs, textarea,
theme_toggle, tooltip, and typography components.

Also adds missing stub methods for typography docs (Components.Heading,
Components.TypographyList, InlineCode, docs_installation_path).
@djalmaaraujo djalmaaraujo requested a review from cirdes as a code owner December 10, 2025 21:25
@cirdes cirdes merged commit 6063574 into docs/batch-4 Dec 11, 2025
2 checks passed
@cirdes cirdes deleted the docs/batch-5 branch December 11, 2025 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants