History

Merge pull request #1227 from rickmacgillis/patch1

Document thor docs:download --all

Simon Legner committed 5 years ago

Commit d5636672 parents 41ab102 fd5b25c2 files · +2 −2Browse files

Unified · Split

2 files
  1. README.md +1 −1
  2. lib/tasks/docs.thor +1 −1
README.md+1−1
@@ -34,7 +34,7 @@ bundle exec rackup · 33 unmodified lines
3434
3535 Finally, point your browser at [localhost:9292](http://localhost:9292) (the first request will take a few seconds to compile the assets). You're all set.
3636
37−The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`.
37+The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`. To download and install all documentation this project has available, run `thor docs:download --all`.
3838
3939 **Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/freeCodeCamp/devdocs/subscription) this repository.
4040
lib/tasks/docs.thor+1−1
@@ -119,7 +119,7 @@ class DocsCLI < Thor · 118 unmodified lines
119119 puts 'Done'
120120 end
121121
122− desc 'download (<doc> <doc@version>... | --default | --installed)', 'Download documentations'
122+ desc 'download (<doc> <doc@version>... | --default | --installed | --all)', 'Download documentations'
123123 option :default, type: :boolean
124124 option :installed, type: :boolean
125125 option :all, type: :boolean