Skip to content

Commit bfa6176

Browse files
committed
Fix merge conflict
2 parents 3a32716 + 0a267cb commit bfa6176

File tree

217 files changed

+1835
-479
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

217 files changed

+1835
-479
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea
5555
* Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.).
5656
* Names must be as short as possible and unique across the documentation.
5757
* The number of types (categories) should ideally be less than 100.
58-
* Don't modify the icon sprite. I'll do it after your pull request is merged.
5958

6059
## Updating existing documentations
6160

6261
Please don't submit a pull request updating the version number of a documentation, unless a change is required in the scraper and you've verified that it works.
6362

64-
To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
63+
To ask that an existing documentation be updated, first check the last two [documentation versions reports](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc). Only create an issue if the documentation has been wrongly marked as up-to-date.
6564

6665
## Coding conventions
6766

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
Please read the contributing guidelines before opening an issue:
33
https://github.com/freeCodeCamp/devdocs/blob/master/.github/CONTRIBUTING.md
44
5-
To request a new documentation, or an update of an existing documentation, go here:
5+
Go here to request a new documentation:
66
https://trello.com/b/6BmTulfx/devdocs-documentation
77
-->

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.DS_Store
22
.bundle
3+
log
34
tmp
45
public/assets
56
public/fonts

.slugignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
public/icons
2-
test
1+
test

.travis.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
language: ruby
22

3+
addons:
4+
apt:
5+
packages:
6+
- libcurl4-openssl-dev
7+
38
cache: bundler
49

510
before_script:
611
- gem update --system
712
- gem install bundler
13+
14+
script:
15+
- if [ "$TRAVIS_EVENT_TYPE" != "cron" ]; then bundle exec rake; fi
16+
- if [ "$TRAVIS_EVENT_TYPE" = "cron" ]; then bundle exec thor updates:check --github-token $GH_TOKEN --upload; fi
17+
18+
deploy:
19+
provider: heroku
20+
app: devdocs
21+
on:
22+
branch: master
23+
condition: $TRAVIS_EVENT_TYPE != cron
24+
api_key:
25+
secure: "4p1klvWJZSOImzFcKOduILjP93hlOlAhceWlYMKS4tU+TCFE8qTBzdKdFPSCsCgjB+YR9pBss+L0lJpVVMjSwFHXqpKe6EeUSltO2k7DFHfW7kXLUM/L0AfqXz+YXk76XUyZMhvOEbldPfaMaj10e8vgDOQCSHABDyK/4CU+hnI="

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
FROM ruby:2.6.0
22

33
ENV LANG=C.UTF-8
4+
ENV ENABLE_SERVICE_WORKER=true
45

56
WORKDIR /devdocs
67

Dockerfile-alpine

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
FROM ruby:2.6.0-alpine
22

33
ENV LANG=C.UTF-8
4+
ENV ENABLE_SERVICE_WORKER=true
45

56
WORKDIR /devdocs
67

Gemfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ group :app do
2222
gem 'browser'
2323
gem 'sass'
2424
gem 'coffee-script'
25+
gem 'chunky_png'
26+
gem 'sprockets-sass'
2527
end
2628

2729
group :production do
@@ -40,6 +42,7 @@ group :docs do
4042
gem 'unix_utils', require: false
4143
gem 'tty-pager', require: false
4244
gem 'net-sftp', '>= 2.1.3.rc2', require: false
45+
gem 'terminal-table', require: false
4346
end
4447

4548
group :test do

Gemfile.lock

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ GEM
1212
erubi (>= 1.0.0)
1313
rack (>= 0.9.0)
1414
browser (2.5.3)
15+
chunky_png (1.3.10)
1516
coderay (1.1.2)
1617
coffee-script (2.4.1)
1718
coffee-script-source
@@ -96,11 +97,15 @@ GEM
9697
rack (> 1, < 3)
9798
sprockets-helpers (1.2.1)
9899
sprockets (>= 2.2)
100+
sprockets-sass (2.0.0.beta2)
101+
sprockets (>= 2.0, < 4.0)
99102
strings (0.1.5)
100103
strings-ansi (~> 0.1)
101104
unicode-display_width (~> 1.5)
102105
unicode_utils (~> 1.4)
103106
strings-ansi (0.1.0)
107+
terminal-table (1.8.0)
108+
unicode-display_width (~> 1.1, >= 1.1.1)
104109
thin (1.7.2)
105110
daemons (~> 1.0, >= 1.0.9)
106111
eventmachine (~> 1.0, >= 1.0.4)
@@ -132,6 +137,7 @@ DEPENDENCIES
132137
activesupport (~> 5.2)
133138
better_errors
134139
browser
140+
chunky_png
135141
coffee-script
136142
erubi
137143
html-pipeline
@@ -153,6 +159,8 @@ DEPENDENCIES
153159
sinatra-contrib
154160
sprockets
155161
sprockets-helpers
162+
terminal-table
163+
sprockets-sass
156164
thin
157165
thor
158166
tty-pager

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ The web app is all client-side JavaScript, written in [CoffeeScript](http://coff
5959

6060
Many of the code's design decisions were driven by the fact that the app uses XHR to load content directly into the main frame. This includes stripping the original documents of most of their HTML markup (e.g. scripts and stylesheets) to avoid polluting the main frame, and prefixing all CSS class names with an underscore to prevent conflicts.
6161

62-
Another driving factor is performance and the fact that everything happens in the browser. `applicationCache` (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
62+
Another driving factor is performance and the fact that everything happens in the browser. A service worker (which comes with its own set of constraints) and `localStorage` are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.
6363

6464
DevDocs being a developer tool, the browser requirements are high:
6565

6666
* Recent versions of Firefox, Chrome, or Opera
67-
* Safari 9.1+
68-
* Edge 16+
69-
* iOS 10+
67+
* Safari 11.1+
68+
* Edge 17+
69+
* iOS 11.3+
7070

7171
This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun!
7272

@@ -156,7 +156,7 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C
156156
* [Doc Browser](https://github.com/qwfy/doc-browser) is a native Linux app that supports DevDocs docsets
157157
* [GNOME Application](https://github.com/hardpixel/devdocs-desktop) GTK3 application with search integrated in headerbar
158158
* [macOS Application](https://github.com/dteoh/devdocs-macos)
159-
* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView with AppCache enabled
159+
* [Android Application](https://github.com/Merith-TK/devdocs_webapp_kotlin) is a fully working, advanced WebView
160160

161161
## Copyright / License
162162

0 commit comments

Comments
 (0)