Skip to content

Commit cebb5fe

Browse files
authored
Merge branch 'main' into update-readme
2 parents 0549112 + dd4f641 commit cebb5fe

File tree

4 files changed

+6
-7
lines changed

4 files changed

+6
-7
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
steps:
1414
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
1515
- name: Set up Ruby
16-
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0
16+
uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
1717
with:
1818
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
1919
- name: Run tests

.github/workflows/schedule-doc-report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
steps:
1111
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
1212
- name: Set up Ruby
13-
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0
13+
uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
1414
with:
1515
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
1616
- name: Generate report

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
steps:
1212
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
1313
- name: Set up Ruby
14-
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0
14+
uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
1515
with:
1616
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
1717
- name: Run tests

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Unless you wish to contribute to the project, we recommend using the hosted vers
2222

2323
DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
2424

25-
2625
DevDocs requires Ruby 3.2.2 (defined in [`Gemfile`](./Gemfile)), libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
2726

2827
```sh
@@ -54,12 +53,12 @@ docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
5453

5554
DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.
5655

57-
The app's main goals are to:
56+
The app's main goals are to:
5857

5958
* Keep load times as short as possible
6059
* Improve the quality, speed, and order of search results
6160
* Maximize the use of caching and other performance optimizations
62-
* Maintain a clean and readable user interface
61+
* Maintain a clean and readable user interface
6362
* Be fully functional offline
6463
* Support full keyboard navigation
6564
* Reduce “context switch” by using a consistent typography and design across all documentations
@@ -127,7 +126,7 @@ thor docs:clean # Delete documentation packages
127126
thor console # Start a REPL
128127
thor console:docs # Start a REPL in the "Docs" module
129128

130-
# Tests can be run quickly from within the console using the "test" command.
129+
# Tests can be run quickly from within the console using the "test" command.
131130
# Run "help test" for usage instructions.
132131
thor test:all # Run all tests
133132
thor test:docs # Run "Docs" tests

0 commit comments

Comments
 (0)