Skip to content

Commit 9cf86ce

Browse files
committed
docs: Simplify docker document
1 parent 755a00a commit 9cf86ce

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,36 @@ $ bundle install
3232

3333
## Build docs
3434

35+
For the latest Rails version:
36+
3537
```console
3638
$ rake build
3739
```
3840

3941
This command generates Rails docs with `default_rails_version` defined in `_config.yml`.
4042

41-
## Serve docs
42-
43-
Serve html under `src` directory.
43+
For specific Rails versions:
4444

4545
```console
46-
$ bundle exec jekyll server
46+
$ rake build_multi[5.2,6.0,6.1]
4747
```
4848

49-
## Docker Usage
49+
### Using docker for the older Rails build
5050

51-
You can run this project using Docker Compose:
51+
Set `RUBY_VERSION` in `.env` file and run `docker compose`.
5252

53-
```bash
54-
# Run the application
55-
docker compose run --rm app bundle exec rake
53+
```console
54+
$ cp .env.example .env
55+
$ docker compose run app bash -c 'rake build_multi[5.2]'
56+
```
5657

57-
# Run with a specific Ruby version
58-
RUBY_VERSION=3.3 docker compose run --rm app bundle exec rake
58+
## Serve docs
5959

60-
# Run Jekyll server for development
61-
docker compose run --rm --service-ports app bundle exec jekyll serve --host 0.0.0.0
62-
```
60+
Serve html under `src` directory.
6361

64-
The Docker setup uses the official Ruby image and includes:
65-
- Ruby with YJIT enabled for better performance
66-
- Automatic bundle installation
67-
- Volume mounting for live development
62+
```console
63+
$ bundle exec jekyll server
64+
```
6865

6966
## Feature Request
7067

0 commit comments

Comments
 (0)