Skip to content

Commit 5112879

Browse files
authored
Docs readme and local convenience (#19)
* Add README with local serving instructions and convenience rakefile * update contributor based on main repo * only run bundle install if needed
1 parent 2a207f9 commit 5112879

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Roo Code Docs
2+
3+
## Prerequisites
4+
5+
Before running the documentation locally, ensure you have:
6+
- Ruby installed (2.5.0 or higher recommended)
7+
- Bundler gem installed (`gem install bundler`)
8+
9+
## Local Development
10+
11+
To build and serve the documentation locally:
12+
13+
```bash
14+
rake serve
15+
```
16+
17+
The documentation will be available at http://127.0.0.1:4000
18+
19+
## Contributing
20+
21+
We love community contributions! Here's how to get involved:
22+
23+
1. Check Issues & Requests: See open issues or feature requests.
24+
2. Fork & branch off main.
25+
3. Submit a Pull Request once your documentation feature or fix is ready.
26+
4. Join our Reddit community and Discord for feedback, tips, and announcements.

Rakefile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
desc 'Build documentation site locally'
2+
task :serve do
3+
Dir.chdir('docs') do
4+
# Only run bundle install if Gemfile.lock doesn't exist
5+
sh 'bundle install' unless File.exist?('Gemfile.lock')
6+
sh 'bundle exec jekyll serve'
7+
end
8+
end
9+
10+
# Set default task
11+
task default: :serve

0 commit comments

Comments
 (0)