Skip to content

Commit

Permalink
Merge pull request freeCodeCamp#1227 from rickmacgillis/patch1
Browse files Browse the repository at this point in the history
Document thor docs:download --all
  • Loading branch information
simon04 authored Nov 14, 2020
2 parents 41ab102 + fd5b25c commit d563667
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ bundle exec rackup

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.

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`.
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`.

**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.

Expand Down
2 changes: 1 addition & 1 deletion lib/tasks/docs.thor
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ class DocsCLI < Thor
puts 'Done'
end

desc 'download (<doc> <doc@version>... | --default | --installed)', 'Download documentations'
desc 'download (<doc> <doc@version>... | --default | --installed | --all)', 'Download documentations'
option :default, type: :boolean
option :installed, type: :boolean
option :all, type: :boolean
Expand Down

0 comments on commit d563667

Please sign in to comment.