Unified · Split
| @@ -35,7 +35,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 34 unmodified lines | ||
| 35 | 35 | ## Contributing code and features |
| 36 | 36 | |
| 37 | 37 | 1. Search for existing issues; someone may already be working on a similar feature. |
| 38 | −2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature. | |
| 38 | +2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature. | |
| 39 | 39 | 3. Follow the [coding conventions](#coding-conventions). |
| 40 | 40 | 4. If you're modifying the Ruby code, include tests and ensure they pass. |
| 41 | 41 | 5. Try to keep your pull request small and simple. |
| @@ -5,9 +5,9 @@ Copyright 2013-2018 Thibaut Courouble and other contributors · 4 unmodified lines | ||
| 5 | 5 | file, You can obtain one at http://mozilla.org/MPL/2.0/. |
| 6 | 6 | |
| 7 | 7 | Please do not use the name DevDocs to endorse or promote products |
| 8 | −derived from this software without my permission, except as may be | |
| 9 | −necessary to comply with the notice/attribution requirements. | |
| 8 | +derived from this software without the maintainers' permission, except | |
| 9 | +as may be necessary to comply with the notice/attribution requirements. | |
| 10 | 10 | |
| 11 | −I also wish that any documentation file generated using this software | |
| 11 | +We also wish that any documentation file generated using this software | |
| 12 | 12 | be attributed to DevDocs. Let's be fair to all contributors by giving |
| 13 | 13 | credit where credit's due. Thanks. |
| @@ -1,8 +1,8 @@ | ||
| 1 | −# [DevDocs](https://devdocs.io) [](https://travis-ci.org/freeCodeCamp/devdocs) | |
| 1 | +# [DevDocs](https://devdocs.io) — API Documentation Browser [](https://travis-ci.org/freeCodeCamp/devdocs) | |
| 2 | 2 | |
| 3 | −DevDocs combines multiple API documentations in a fast, organized, and searchable interface. | |
| 3 | +DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 4 | 4 | |
| 5 | −* Created by [Thibaut Courouble](https://thibaut.me) | |
| 5 | +DevDocs was created by [Thibaut Courouble](https://thibaut.me) and is operated by [freeCodeCamp](https://www.freecodecamp.org). | |
| 6 | 6 | |
| 7 | 7 | Keep track of development news: |
| 8 | 8 | |
| @@ -14,7 +14,7 @@ Keep track of development news: · 5 unmodified lines | ||
| 14 | 14 | |
| 15 | 15 | ## Quick Start |
| 16 | 16 | |
| 17 | −Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box. | |
| 17 | +Unless you wish to contribute to the project, we recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box. | |
| 18 | 18 | |
| 19 | 19 | 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. |
| 20 | 20 | |
| @@ -138,9 +138,9 @@ Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.co · 117 unmodified lines | ||
| 138 | 138 | |
| 139 | 139 | This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files. |
| 140 | 140 | |
| 141 | −Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements. | |
| 141 | +Please do not use the name DevDocs to endorse or promote products derived from this software without the maintainers' permission, except as may be necessary to comply with the notice/attribution requirements. | |
| 142 | 142 | |
| 143 | −I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks! | |
| 143 | +We also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks! | |
| 144 | 144 | |
| 145 | 145 | ## Questions? |
| 146 | 146 | |
| @@ -62,12 +62,12 @@ app.templates.unsupportedBrowser = """ · 61 unmodified lines | ||
| 62 | 62 | <li>iOS 10+ |
| 63 | 63 | </ul> |
| 64 | 64 | <p class="_fail-text"> |
| 65 | − If you're unable to upgrade, I apologize. | |
| 66 | − I decided to prioritize speed and new features over support for older browsers. | |
| 65 | + If you're unable to upgrade, we apologize. | |
| 66 | + We decided to prioritize speed and new features over support for older browsers. | |
| 67 | 67 | <p class="_fail-text"> |
| 68 | 68 | Note: if you're already using one of the browsers above, check your settings and add-ons. |
| 69 | 69 | The app uses feature detection, not user agent sniffing. |
| 70 | 70 | <p class="_fail-text"> |
| 71 | − — Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a> | |
| 71 | + — <a href="https://twitter.com/DevDocs">@DevDocs</a> | |
| 72 | 72 | </div> |
| 73 | 73 | """ |
| @@ -11,16 +11,12 @@ app.templates.aboutPage = -> """ · 10 unmodified lines | ||
| 11 | 11 | </nav> |
| 12 | 12 | |
| 13 | 13 | <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1> |
| 14 | − <p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 15 | − <ul> | |
| 16 | − <li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a> | |
| 17 | − <li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a> | |
| 18 | − <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe> | |
| 19 | − </ul> | |
| 14 | + <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more. | |
| 15 | + <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>. | |
| 20 | 16 | <p>To keep up-to-date with the latest news: |
| 21 | 17 | <ul> |
| 22 | 18 | <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter |
| 23 | − <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> | |
| 19 | + <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe> | |
| 24 | 20 | <li>Join the <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a> chat room |
| 25 | 21 | </ul> |
| 26 | 22 | |
| @@ -52,7 +48,6 @@ app.templates.aboutPage = -> """ · 25 unmodified lines | ||
| 52 | 48 | <dt>Where can I report bugs? |
| 53 | 49 | <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks! |
| 54 | 50 | </dl> |
| 55 | − <p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>. | |
| 56 | 51 | |
| 57 | 52 | <h2 class="_block-heading" id="credits">Credits</h2> |
| 58 | 53 | |
| @@ -76,12 +71,12 @@ app.templates.aboutPage = -> """ · 17 unmodified lines | ||
| 76 | 71 | |
| 77 | 72 | <h2 class="_block-heading" id="privacy">Privacy Policy</h2> |
| 78 | 73 | <ul> |
| 79 | − <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by Thibaut Courouble ("We"). | |
| 80 | − <li>We do not collect personal information. | |
| 74 | + <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We"). | |
| 75 | + <li>We do not collect personal information through the app. | |
| 81 | 76 | <li>We use Google Analytics, Gauges and Sentry to collect anonymous traffic information and improve the app. |
| 82 | 77 | <li>The app uses cookies to store user preferences. |
| 83 | 78 | <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app. |
| 84 | − <li>If you have any questions regarding privacy, please email <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>. | |
| 79 | + <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>. | |
| 85 | 80 | </ul> |
| 86 | 81 | """ |
| 87 | 82 | |
| @@ -32,5 +32,3 @@ · 31 unmodified lines | ||
| 32 | 32 | } |
| 33 | 33 | |
| 34 | 34 | ._fail-text:last-child { margin: 0; } |
| 35 | − | |
| 36 | −._fail-link { float: right; } | |
| @@ -16,11 +16,11 @@ · 15 unmodified lines | ||
| 16 | 16 | <li>iOS 10+</li> |
| 17 | 17 | </ul> |
| 18 | 18 | <p class="_fail-text"> |
| 19 | − If you're unable to upgrade, I apologize. | |
| 20 | − I decided to prioritize speed and new features over support for older browsers. | |
| 19 | + If you're unable to upgrade, we apologize. | |
| 20 | + We decided to prioritize speed and new features over support for older browsers. | |
| 21 | 21 | </p> |
| 22 | 22 | <p class="_fail-text"> |
| 23 | − — Thibaut <a href="https://twitter.com/DevDocs" class="_fail-link">@DevDocs</a> | |
| 23 | + — <a href="https://twitter.com/DevDocs">@DevDocs</a> | |
| 24 | 24 | </p> |
| 25 | 25 | </div> |
| 26 | 26 | </body> |