devdocs/README.md

DevDocs — Documentation Browser

DevDocs combines multiple API documentations in a fast, organized, and searchable interface.

• Created by Thibaut Courouble
• Made at Shopify
• Powered by MaxCDN

Keep track of development and community news:

• Watch the repository on GitHub
• Follow @DevDocs on Twitter
• Subscribe to the newsletter
• Join the mailing list

DevDocs is free and open source. If you like it, please consider funding the project on Gratipay. Thanks!

Table of Contents: Quick Start · Vision · App · Scraper · Commands · Contributing · License · Questions?

Quick Start

Unless you want to contribute to the project, I recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box.

DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and index files, and a JavaScript app powered by a small Sinatra app.

DevDocs requires Ruby 2.2.0 and a JavaScript runtime supported by ExecJS (included in OS X and Windows; Node.js on Linux). Once you have these installed, run the following commands:

git clone https://github.com/Thibaut/devdocs.git && cd devdocs
gem install bundler
bundle install
thor docs:download --all
rackup

Finally, point your browser at 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/update individual documentations (e.g. thor docs:download html css), or all at the same time (using the --all option). You can see the list of available documentations by running thor docs:list.

Note: there is currently no update mechanism other than git pull origin master to update the code and thor docs:download to download the latest version of the docs. To stay informed about new releases, be sure to watch this repository and/or subscribe to the newsletter.

Vision

DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.

The app's main goals are to: keep boot and load times as short as possible; improve the quality, speed, and order of search results; maximize the use of caching and other performance optimizations; maintain a clean, readable user interface; be fully functional offline; support full keyboard navigation; reduce “context switch” by using a consistent typography and design across all documentations; reduce clutter by focusing on a specific category of content (API/reference) and indexing only the minimum useful to most developers.

Note: DevDocs is neither a programming guide nor a search engine. All content is pulled from third-party sources and the project doesn't intend to compete with full-text search engines. Its backbone is metadata: each piece of content must be identified by a unique, "obvious" and short string. Tutorials, guides and other content that don't meet this requirement are outside the scope of the project.

App

The web app is all JavaScript, written in CoffeeScript, and powered by a small Sinatra/Sprockets application. It relies on files generated by the scraper.

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.

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. On the other hand, the search algorithm is currently not very sophisticated because it needs to be fast even searching through 100,000 entries.

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

1. On the desktop:

• Recent version of Chrome
• Recent version of Firefox
• Safari 5.1+
• Opera 12.1+
• Internet Explorer 10+

2. On mobile:

• iOS 6+
• Android 4.1+
• Windows Phone 8+

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

Scraper

The scraper is responsible for generating the documentation and index files (metadata) used by the app. It's written in Ruby under the Docs module.

There are currently two kinds of scrapers: UrlScraper which downloads files via HTTP and FileScraper which reads them from the local filesystem. They both make copies of HTML documents, recursively following links that match a set of rules and applying all sorts of modifications along the way, in addition to building an index of the files and their metadata. Documents are parsed using Nokogiri.

Modifications made to each document include:

• removing content such as the document structure (<html>, <head>, etc.), comments, empty nodes, etc.
• fixing links (e.g. to remove duplicates)
• replacing all external (not scraped) URLs with their fully qualified counterpart
• replacing all internal (scraped) URLs with their unqualified and relative counterpart
• adding content, such as a title and link to the original document

These modifications are applied via a set of filters using the HTML::Pipeline library. Each scraper includes filters specific to its documentation, one of which is tasked with figuring out the pages' metadata.

The end result is a set of normalized HTML partials and a JSON index file. Because the index files are loaded separately by the app following the user's preferences, the code also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).

More information about scrapers and filters is available on the wiki.

Available Commands

The command-line interface uses Thor. To see all commands and options, run thor list from the project's root.

# Server
rackup              # Start the server (ctrl+c to stop)
rackup --help       # List server options

# Docs
thor docs:list      # List available documentations
thor docs:download  # Download one or more documentations
thor docs:manifest  # Create the manifest file used by the app
thor docs:generate  # Generate/scrape a documentation
thor docs:page      # Generate/scrape a documentation page
thor docs:package   # Package a documentation for use with docs:download
thor docs:clean     # Delete documentation packages

# Console
thor console        # Start a REPL
thor console:docs   # Start a REPL in the "Docs" module
Note: tests can be run quickly from within the console using the "test" command. Run "help test"
for usage instructions.

# Tests
thor test:all       # Run all tests
thor test:docs      # Run "Docs" tests
thor test:app       # Run "App" tests

# Assets
thor assets:compile # Compile assets (not required in development mode)
thor assets:clean   # Clean old assets

Contributing

Contributions are welcome. Please read the contributing guidelines.

DevDocs's own documentation is available on the wiki.

Copyright / License

Copyright 2013-2015 Thibaut Courouble and other contributors

This software is licensed under the terms of the Mozilla Public License v2.0. See the COPYRIGHT and LICENSE files.

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.

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!

Questions?

If you have any questions, please feel free to ask them on the mailing list.