Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.

Commit 3158cdc

Browse files
authored
Revise contributing guide and link to documentation
Updated README to remove local development setup instructions and link to documentation.
1 parent d401dd7 commit 3158cdc

1 file changed

Lines changed: 1 addition & 28 deletions

File tree

README.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1 @@
1-
Rails need a plug n play system for creating streamlined ui components.
2-
3-
Phlex looks fun and fast, so I thought I'd start creating ui components with it.
4-
5-
## Contributing - Local Development Setup
6-
7-
### Install the Gem Locally
8-
9-
To contribute to this project, it's recommended to install the gem locally and point to it in your Gemfile:
10-
11-
```ruby
12-
gem "ruby_ui", path: "../ruby_ui"
13-
```
14-
15-
## Working with Components
16-
17-
### Component Development Workflow
18-
19-
1. Eject the component you want to modify using the generator:
20-
```bash
21-
rails generate ruby_ui:component combobox
22-
```
23-
2. Make your desired changes to the ejected component
24-
3. Once you're satisfied with the modifications, integrate the component back into the gem in the appropriate location
25-
26-
This workflow allows you to iterate quickly on components while maintaining the gem's structure.
27-
28-
Would you like me to expand on any part of the contributing guide?
1+
Moved to https://github.com/ruby-ui/ruby_ui/tree/main/docs.

0 commit comments

Comments
 (0)