Update README.md and CONTRIBUTING.md

Thibaut Courouble committed 10 years ago

Commit dd0d5cb1 parent 85c7de92 files · +12 −12Browse files

Unified · Split

2 files

CONTRIBUTING.md +5 −5
README.md +7 −7

@@ -32,7 +32,7 @@ For general feedback and ideas, please use the [mailing list](https://groups.goo · 31 unmodified lines
32	32	## Requesting new documentations
33	33
34	34	Please don't open issues to request new documentations.
35		−Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote and contributors can get a feel for what is most wished for.
	35	+Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote.
36	36
37	37	## Contributing code and features
38	38
@@ -54,16 +54,16 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea · 15 unmodified lines
54	54
55	55	* Your documentation must come with an official icon, in both 1x and 2x resolutions (16x16 and 32x32 pixels). This is important because icons are the only thing differentiating search results in the UI.
56	56	* DevDocs favors quality over quantity. Your documentation should only include documents that most developers may want to read semi-regularly. By reducing the number of entries, we make it easier to find other, more relevant entries.
57		−* Try to remove as much content and HTML markup as possible, particularly content which isn't associated with any entries (e.g. introduction, changelog, etc.).
	57	+* Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.).
58	58	* Names must be as short as possible and unique across the documentation.
59	59	* The number of types (categories) should ideally be less than 100.
60	60	* Don't modify the icon sprite. I'll do it after your pull request is merged.
61	61
62	62	## Updating existing documentations
63	63
64		−Please don't submit a pull request updating the version number of a documentation unless you've verified that it can be generated properly using the current code. Because the original content will have changed, the code will likely need to be tweaked.
	64	+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.
65	65
66		−To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here) or the [mailing list](https://groups.google.com/d/forum/devdocs).
	66	+To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
67	67
68	68	## Other contributions
69	69
@@ -75,7 +75,7 @@ Besides new docs and features, here are other ways you can contribute: · 5 unmodified lines
75	75	## Coding conventions
76	76
77	77	* two spaces; no tabs
78		−* no trailing whitespace; blank lines should have no spaces
	78	+* no trailing whitespace; blank lines should have no spaces; new line at end-of-file
79	79	* use the same coding style as the rest of the codebase
80	80
81	81	## Questions?

README.md+7−7

@@ -4,7 +4,7 @@ DevDocs combines multiple API documentations in a fast, organized, and searchabl · 3 unmodified lines
4	4
5	5	* Created by [Thibaut Courouble](http://thibaut.me)
6	6
7		−Keep track of development and community news:
	7	+Keep track of development news:
8	8
9	9	* Watch the repository on [GitHub](https://github.com/Thibaut/devdocs/subscription)
10	10	* Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
@@ -18,9 +18,9 @@ DevDocs is free and open source. If you like it, please consider supporting my w · 7 unmodified lines
18	18
19	19	Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](http://devdocs.io). It's up-to-date and works offline out-of-the-box.
20	20
21		−DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
	21	+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.
22	22
23		−DevDocs requires Ruby 2.3.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/sstephenson/execjs#readme) (included in OS X and Windows; [Node.js](http://nodejs.org/) on Linux). Once you have these installed, run the following commands:
	23	+DevDocs requires Ruby 2.3.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
24	24
25	25	```
26	26	git clone https://github.com/Thibaut/devdocs.git && cd devdocs
@@ -53,11 +53,11 @@ DevDocs aims to make reading and searching reference documentation fast, easy an · 26 unmodified lines
53	53
54	54	The app's main goals are to: keep 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 and 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.
55	55
56		−Note: DevDocs is neither a programming guide nor a search engine. All our 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 is 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.
	56	+Note: DevDocs is neither a programming guide nor a search engine. All our 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 is 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.
57	57
58	58	## App
59	59
60		−The web app is all client-side JavaScript, written in [CoffeeScript](http://coffeescript.org), and powered by a small [Sinatra](http://www.sinatrarb.com)/[Sprockets](https://github.com/sstephenson/sprockets) application. It relies on files generated by the [scraper](#scraper).
	60	+The web app is all client-side JavaScript, written in [CoffeeScript](http://coffeescript.org), and powered by a small [Sinatra](http://www.sinatrarb.com)/[Sprockets](https://github.com/rails/sprockets) application. It relies on files generated by the [scraper](#scraper).
61	61
62	62	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.
63	63
@@ -92,9 +92,9 @@ Modifications made to each document include: · 28 unmodified lines
92	92	* replacing all internal (scraped) URLs with their unqualified and relative counterpart
93	93	* adding content, such as a title and link to the original document
94	94
95		−These modifications are applied via a set of filters using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. Each scraper includes filters specific to its documentation, one of which is tasked with figuring out the pages' metadata.
	95	+These modifications are applied via a set of filters using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. Each scraper includes filters specific to itself, one of which is tasked with figuring out the pages' metadata.
96	96
97		−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](#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.).
	97	+The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).
98	98
99	99	More information about scrapers and filters is available on the [wiki](https://github.com/Thibaut/devdocs/wiki).
100	100