Merge branch 'main' into update-readme

pull/2066/head
Simon Legner 1 year ago committed by GitHub
commit cebb5fe382
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -13,7 +13,7 @@ jobs:
steps: steps:
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0 - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
- name: Set up Ruby - name: Set up Ruby
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0 uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
with: with:
bundler-cache: true # runs 'bundle install' and caches installed gems automatically bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Run tests - name: Run tests

@ -10,7 +10,7 @@ jobs:
steps: steps:
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0 - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
- name: Set up Ruby - name: Set up Ruby
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0 uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
with: with:
bundler-cache: true # runs 'bundle install' and caches installed gems automatically bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Generate report - name: Generate report

@ -11,7 +11,7 @@ jobs:
steps: steps:
- uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0 - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
- name: Set up Ruby - name: Set up Ruby
uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47 # v1.154.0 uses: ruby/setup-ruby@d37167af451eb51448db3354e1057b75c4b268f7 # v1.155.0
with: with:
bundler-cache: true # runs 'bundle install' and caches installed gems automatically bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Run tests - name: Run tests

@ -22,7 +22,6 @@ Unless you wish to contribute to the project, we recommend using the hosted vers
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. 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.
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: 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:
```sh ```sh
@ -54,12 +53,12 @@ docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.
The app's main goals are to: The app's main goals are to:
* Keep load times as short as possible * Keep load times as short as possible
* Improve the quality, speed, and order of search results * Improve the quality, speed, and order of search results
* Maximize the use of caching and other performance optimizations * Maximize the use of caching and other performance optimizations
* Maintain a clean and readable user interface * Maintain a clean and readable user interface
* Be fully functional offline * Be fully functional offline
* Support full keyboard navigation * Support full keyboard navigation
* Reduce “context switch” by using a consistent typography and design across all documentations * Reduce “context switch” by using a consistent typography and design across all documentations
@ -127,7 +126,7 @@ thor docs:clean # Delete documentation packages
thor console # Start a REPL thor console # Start a REPL
thor console:docs # Start a REPL in the "Docs" module thor console:docs # Start a REPL in the "Docs" module
# Tests can be run quickly from within the console using the "test" command. # Tests can be run quickly from within the console using the "test" command.
# Run "help test" for usage instructions. # Run "help test" for usage instructions.
thor test:all # Run all tests thor test:all # Run all tests
thor test:docs # Run "Docs" tests thor test:docs # Run "Docs" tests

Loading…
Cancel
Save