Skip to content

Commit d3ddafa

Browse files
committed
docs: add rbenv installation instructions to README
1 parent 4917443 commit d3ddafa

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,8 @@ We welcome contributions from the community! Whether you're fixing a typo or add
2222
- Use absolute paths for images: `![Alt Text](/assets/images/my_image.png)`.
2323
- Use absolute paths for internal links: `[Other Page](/wiki/category/other-page/)`.
2424
6. **Navigation**: Add your entry to `/_data/navigation.yml` and the parent category's `index.md`.
25-
7. **PR**: Submit a Pull Request. Our editors will review and provide feedback.
26-
27-
### Tools We Recommend
28-
- **Editor**: [VS Code](https://code.visualstudio.com/) with Markdown extensions.
29-
- **Preview**: [Jekyll](https://jekyllrb.com/) (see Local Development below).
30-
- **Web Editor**: [Prose.io](http://prose.io/) for quick browser-based edits.
25+
7. **Build & Test**: See 'Local Development' below on instructions to build and deploylocally. Open all modified pages and verify your changes visually.
26+
7. **PR**: Submit a Pull Request. Our editors will review and provide feedback. Follow through with changes until merge.
3127

3228
---
3329

@@ -36,19 +32,29 @@ We welcome contributions from the community! Whether you're fixing a typo or add
3632
To build and preview the site locally, we recommend using a Ruby virtual environment for dependency isolation.
3733

3834
### Prerequisites
39-
- **Ruby**: Version specified in [`.ruby-version`](.ruby-version). We recommend [rbenv](https://github.com/rbenv/rbenv).
40-
- **Bundler**: `gem install bundler`
35+
- **Ruby version manager**: We recommend [rbenv](https://github.com/rbenv/rbenv) to manage Ruby versions.
36+
- **macOS**: `brew install rbenv`
37+
- **Linux**: See the [rbenv installer](https://github.com/rbenv/rbenv-installer) or use your package manager.
4138

4239
### Setup and Build
43-
1. **Configure local path**:
40+
1. **Install Ruby**:
41+
From root of the project, run:
42+
```bash
43+
rbenv install $(cat .ruby-version)
44+
```
45+
2. **Install Bundler**:
46+
```bash
47+
gem install bundler
48+
```
49+
3. **Configure local path**:
4450
```bash
4551
bundle config set --local path 'vendor/bundle'
4652
```
47-
2. **Install dependencies**:
53+
4. **Install dependencies**:
4854
```bash
4955
bundle install
5056
```
51-
3. **Local Preview**:
57+
5. **Local Preview**:
5258
```bash
5359
bundle exec jekyll serve
5460
```

0 commit comments

Comments
 (0)