Skip to content

Commit 84781bd

Browse files
committed
chore(docs): publish LLM site files
1 parent 8d91365 commit 84781bd

3 files changed

Lines changed: 729 additions & 0 deletions

File tree

docs/public/llms-full.txt

Lines changed: 342 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,342 @@
1+
# RubyUI Full LLM Reference
2+
3+
> RubyUI provides accessible, customizable UI components for Ruby and Rails applications. It is built on Phlex for Ruby-rendered views, Tailwind CSS for styling, and Stimulus for small client-side behaviors.
4+
5+
This file expands the curated /llms.txt map into a compact reference that can be loaded as one document. It is intentionally prose-heavy and link-rich so language models can answer common questions without crawling the whole documentation site.
6+
7+
## Product model
8+
9+
- RubyUI is distributed as the `ruby_ui` gem.
10+
- RubyUI is intended primarily for development-time generation and copy-paste workflows.
11+
- Components are Ruby classes that render HTML through Phlex.
12+
- Styling uses Tailwind CSS utilities and CSS variables.
13+
- Interactive components use lightweight Stimulus controllers.
14+
- The design language is inspired by shadcn/ui and keeps theme tokens compatible with shadcn/ui-style CSS variables.
15+
16+
## Common installation workflow
17+
18+
1. Add the gem to a Rails application with `bundle add ruby_ui --group development --require false`.
19+
2. Run `bin/rails g ruby_ui:install` to install RubyUI support files.
20+
3. Generate a component with `bin/rails g ruby_ui:component ComponentName`, for example `bin/rails g ruby_ui:component Button`.
21+
4. Customize generated Ruby, Tailwind classes, and Stimulus controllers inside the host app as needed.
22+
23+
## Important implementation notes
24+
25+
- Treat generated components as application code, not a sealed runtime dependency.
26+
- Prefer the docs installation path matching the Rails JavaScript setup: JS bundler or import maps.
27+
- Use the theming docs for CSS variable setup before making broad visual changes.
28+
- Use the dark mode docs when adding or moving `ThemeToggle`.
29+
- Component documentation pages usually end with setup tabs and a table of component files.
30+
31+
## Core documentation
32+
33+
### Introduction
34+
35+
- URL: https://rubyui.com/docs/introduction
36+
- Summary: Overview of RubyUI, its Phlex, Tailwind CSS, and Stimulus foundations, and its design goals.
37+
38+
### Installation
39+
40+
- URL: https://rubyui.com/docs/installation
41+
- Summary: Entry point for choosing a Rails installation path.
42+
43+
### Rails - JS Bundler
44+
45+
- URL: https://rubyui.com/docs/installation/rails_bundler
46+
- Summary: Install RubyUI in a Rails app that uses JavaScript bundling.
47+
48+
### Rails - Importmaps
49+
50+
- URL: https://rubyui.com/docs/installation/rails_importmaps
51+
- Summary: Install RubyUI in a Rails app that uses import maps.
52+
53+
### Theming
54+
55+
- URL: https://rubyui.com/docs/theming
56+
- Summary: Use CSS variables and shadcn/ui-compatible theme tokens with RubyUI.
57+
58+
### Dark mode
59+
60+
- URL: https://rubyui.com/docs/dark_mode
61+
- Summary: Configure dark mode with the Tailwind CSS class strategy and RubyUI theme toggle.
62+
63+
### Customizing components
64+
65+
- URL: https://rubyui.com/docs/customizing_components
66+
- Summary: Adapt generated RubyUI components when theme-level customization is not enough.
67+
68+
### Components
69+
70+
- URL: https://rubyui.com/docs/components
71+
- Summary: Catalog of available RubyUI components.
72+
73+
### Changelog
74+
75+
- URL: https://rubyui.com/docs/changelog
76+
- Summary: Recent RubyUI component and documentation changes.
77+
78+
79+
## Component catalog
80+
81+
### Accordion
82+
83+
- URL: https://rubyui.com/docs/accordion
84+
- Summary: Vertically stacked interactive headings that reveal sections of content.
85+
86+
### Alert
87+
88+
- URL: https://rubyui.com/docs/alert
89+
- Summary: Callout component for drawing attention to contextual information.
90+
91+
### Alert Dialog
92+
93+
- URL: https://rubyui.com/docs/alert_dialog
94+
- Summary: Modal dialog for interruptive content that expects a response.
95+
96+
### Aspect Ratio
97+
98+
- URL: https://rubyui.com/docs/aspect_ratio
99+
- Summary: Container for displaying content within a desired ratio.
100+
101+
### Avatar
102+
103+
- URL: https://rubyui.com/docs/avatar
104+
- Summary: Image and fallback primitives for representing a user.
105+
106+
### Badge
107+
108+
- URL: https://rubyui.com/docs/badge
109+
- Summary: Small status or label element.
110+
111+
### Breadcrumb
112+
113+
- URL: https://rubyui.com/docs/breadcrumb
114+
- Summary: Navigation trail showing the current location in a hierarchy.
115+
116+
### Button
117+
118+
- URL: https://rubyui.com/docs/button
119+
- Summary: Button component and button-like variants.
120+
121+
### Calendar
122+
123+
- URL: https://rubyui.com/docs/calendar
124+
- Summary: Date field component for entering and editing dates.
125+
126+
### Card
127+
128+
- URL: https://rubyui.com/docs/card
129+
- Summary: Content container with header, content, and footer primitives.
130+
131+
### Carousel
132+
133+
- URL: https://rubyui.com/docs/carousel
134+
- Summary: Embla-powered carousel with motion and swipe interactions.
135+
136+
### Checkbox
137+
138+
- URL: https://rubyui.com/docs/checkbox
139+
- Summary: Control for toggling between checked and unchecked states.
140+
141+
### Checkbox Group
142+
143+
- URL: https://rubyui.com/docs/checkbox_group
144+
- Summary: Grouped checkbox controls.
145+
146+
### Clipboard
147+
148+
- URL: https://rubyui.com/docs/clipboard
149+
- Summary: Control for copying content to the clipboard.
150+
151+
### Codeblock
152+
153+
- URL: https://rubyui.com/docs/codeblock
154+
- Summary: Highlighted code display component.
155+
156+
### Collapsible
157+
158+
- URL: https://rubyui.com/docs/collapsible
159+
- Summary: Interactive component for expanding and collapsing a panel.
160+
161+
### Combobox
162+
163+
- URL: https://rubyui.com/docs/combobox
164+
- Summary: Autocomplete input and command palette with suggestions.
165+
166+
### Command
167+
168+
- URL: https://rubyui.com/docs/command
169+
- Summary: Composable command menu for Phlex applications.
170+
171+
### Context Menu
172+
173+
- URL: https://rubyui.com/docs/context_menu
174+
- Summary: Right-click menu for contextual actions.
175+
176+
### Data Table
177+
178+
- URL: https://rubyui.com/docs/data_table
179+
- Summary: Data table primitives for search, sorting, pagination, visibility, and bulk actions.
180+
181+
### Date Picker
182+
183+
- URL: https://rubyui.com/docs/date_picker
184+
- Summary: Date picker component with input.
185+
186+
### Dialog
187+
188+
- URL: https://rubyui.com/docs/dialog
189+
- Summary: Modal window that renders background content inert.
190+
191+
### Dropdown Menu
192+
193+
- URL: https://rubyui.com/docs/dropdown_menu
194+
- Summary: Button-triggered menu for actions or functions.
195+
196+
### Form
197+
198+
- URL: https://rubyui.com/docs/form
199+
- Summary: Form fields with built-in client-side validations.
200+
201+
### Hover Card
202+
203+
- URL: https://rubyui.com/docs/hover_card
204+
- Summary: Preview content exposed behind a link or trigger.
205+
206+
### Input
207+
208+
- URL: https://rubyui.com/docs/input
209+
- Summary: Styled input field primitive.
210+
211+
### Link
212+
213+
- URL: https://rubyui.com/docs/link
214+
- Summary: Link component with button-like and underline variants.
215+
216+
### Masked Input
217+
218+
- URL: https://rubyui.com/docs/masked_input
219+
- Summary: Form input with an applied mask.
220+
221+
### Pagination
222+
223+
- URL: https://rubyui.com/docs/pagination
224+
- Summary: Page navigation with next and previous links.
225+
226+
### Popover
227+
228+
- URL: https://rubyui.com/docs/popover
229+
- Summary: Triggered rich content panel.
230+
231+
### Progress
232+
233+
- URL: https://rubyui.com/docs/progress
234+
- Summary: Progress bar for task completion state.
235+
236+
### Radio Button
237+
238+
- URL: https://rubyui.com/docs/radio_button
239+
- Summary: Single-selection control for option lists.
240+
241+
### Native Select
242+
243+
- URL: https://rubyui.com/docs/native_select
244+
- Summary: Styled native HTML select element.
245+
246+
### Select
247+
248+
- URL: https://rubyui.com/docs/select
249+
- Summary: Button-triggered option picker.
250+
251+
### Separator
252+
253+
- URL: https://rubyui.com/docs/separator
254+
- Summary: Visual or semantic divider.
255+
256+
### Sheet
257+
258+
- URL: https://rubyui.com/docs/sheet
259+
- Summary: Side panel for content that complements the main screen.
260+
261+
### Shortcut Key
262+
263+
- URL: https://rubyui.com/docs/shortcut_key
264+
- Summary: Keyboard shortcut display component.
265+
266+
### Sidebar
267+
268+
- URL: https://rubyui.com/docs/sidebar
269+
- Summary: Composable, themeable sidebar component.
270+
271+
### Skeleton
272+
273+
- URL: https://rubyui.com/docs/skeleton
274+
- Summary: Placeholder for loading states.
275+
276+
### Switch
277+
278+
- URL: https://rubyui.com/docs/switch
279+
- Summary: Toggle control for binary settings.
280+
281+
### Table
282+
283+
- URL: https://rubyui.com/docs/table
284+
- Summary: Responsive table component.
285+
286+
### Tabs
287+
288+
- URL: https://rubyui.com/docs/tabs
289+
- Summary: Layered tab panels displayed one at a time.
290+
291+
### Textarea
292+
293+
- URL: https://rubyui.com/docs/textarea
294+
- Summary: Styled multiline text input.
295+
296+
### Theme Toggle
297+
298+
- URL: https://rubyui.com/docs/theme_toggle
299+
- Summary: Toggle control for switching between light and dark themes.
300+
301+
### Tooltip
302+
303+
- URL: https://rubyui.com/docs/tooltip
304+
- Summary: Popup information shown on keyboard focus or hover.
305+
306+
### Typography
307+
308+
- URL: https://rubyui.com/docs/typography
309+
- Summary: Text primitives and sensible typography defaults.
310+
311+
312+
## Examples and demos
313+
314+
### Data Table Demo
315+
316+
- URL: https://rubyui.com/docs/data_table_demo
317+
- Summary: Interactive data table example using RubyUI table primitives.
318+
319+
### Sidebar Example
320+
321+
- URL: https://rubyui.com/docs/sidebar/example
322+
- Summary: Standalone sidebar example page.
323+
324+
### Sidebar Inset Example
325+
326+
- URL: https://rubyui.com/docs/sidebar/inset
327+
- Summary: Sidebar inset layout example page.
328+
329+
330+
## Themes
331+
332+
- [Themes](https://rubyui.com/themes/default): Preview and copy hand-picked themes that are compatible with RubyUI and shadcn/ui token conventions.
333+
334+
## External resources
335+
336+
- [GitHub repository](https://github.com/ruby-ui/ruby_ui): Source code for the RubyUI gem and documentation app.
337+
- [RubyGems package](https://rubygems.org/gems/ruby_ui): Published ruby_ui gem package.
338+
339+
## Companion machine-readable files
340+
341+
- [llms.txt](https://rubyui.com/llms.txt): Curated LLM link map.
342+
- [sitemap.xml](https://rubyui.com/sitemap.xml): XML sitemap for public pages.

0 commit comments

Comments
 (0)