Tweak README.md and CONTRIBUTING.md

Thibaut committed 11 years ago

Commit 3eea84c1 parent 04bc3172 files · +14 −14Browse files

Unified · Split

2 files

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

README.md+7−7

@@ -1,6 +1,6 @@
1	# Contributing to DevDocs	1	# Contributing to DevDocs
2		2
3	Wish to contribute? Great. Please review the following guidelines carefully and always search for existing issues before opening a new one.	3	Want to contribute? Great. Please review the following guidelines carefully and search for existing issues before opening a new one.
4		4
5	Table of Contents:	5	Table of Contents:
6		6
@@ -16,7 +16,7 @@ Wish to contribute? Great. Please review the following guidelines carefully and · 9 unmodified lines
16		16
17	## Reporting bugs	17	## Reporting bugs
18		18
19	1. Always update to the most recent master release; the bug may already be fixed.	19	1. Update to the most recent master release; the bug may already be fixed.
20	2. Search for existing issues; it's possible someone has already encountered this bug.	20	2. Search for existing issues; it's possible someone has already encountered this bug.
21	3. Try to isolate the problem and include steps to reproduce it.	21	3. Try to isolate the problem and include steps to reproduce it.
22	4. Share as much information as possible (e.g. browser/OS environment, log output, stack trace, screenshots, etc.).	22	4. Share as much information as possible (e.g. browser/OS environment, log output, stack trace, screenshots, etc.).
@@ -24,7 +24,7 @@ Wish to contribute? Great. Please review the following guidelines carefully and · 1 unmodified line
24	## Requesting new features	24	## Requesting new features
25		25
26	1. Search for similar feature requests; someone may have already requested it.	26	1. Search for similar feature requests; someone may have already requested it.
27	2. Make sure your feature fits DevDocs's [vision and stated goals](https://github.com/Thibaut/devdocs/blob/master/README.md#vision).	27	2. Make sure your feature fits DevDocs's [vision](https://github.com/Thibaut/devdocs/blob/master/README.md#vision).
28	3. Provide a clear and detailed explanation of the feature and why it's important to add it.	28	3. Provide a clear and detailed explanation of the feature and why it's important to add it.
29		29
30	For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).	30	For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
@@ -37,7 +37,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 6 unmodified lines
37	## Contributing code and features	37	## Contributing code and features
38		38
39	1. Search for existing issues; someone may already be working on a similar feature.	39	1. Search for existing issues; someone may already be working on a similar feature.
40	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 that I may not want to merge. This also tells other contributors that you're working on the feature.	40	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.
41	3. Follow the [coding conventions](#coding-conventions).	41	3. Follow the [coding conventions](#coding-conventions).
42	4. If you're modifying the Ruby code, include tests and ensure they pass.	42	4. If you're modifying the Ruby code, include tests and ensure they pass.
43	5. Try to keep your pull request small and simple.	43	5. Try to keep your pull request small and simple.
@@ -48,14 +48,14 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher · 4 unmodified lines
48		48
49	See the [wiki](https://github.com/Thibaut/devdocs/wiki) to learn how to add new documentations.	49	See the [wiki](https://github.com/Thibaut/devdocs/wiki) to learn how to add new documentations.
50		50
51	Important: the documentation's license must permit alteration, redistribution, and commercial use of the work. Software vendors that wish to add commercial software documentation to DevDocs may contact me privately.	51	Important: the documentation's license must permit alteration, redistribution, and commercial use. Software vendors that wish to add commercial software documentation to DevDocs may contact me privately.
52		52
53	Please open an issue before adding a new documentation.	53	Please open an issue before adding a new documentation.
54		54
55	In addition to the [guidelines for contributing code](#contributing-code-and-features), the following guidelines apply to pull requests that add a new documentation:	55	In addition to the [guidelines for contributing code](#contributing-code-and-features), the following guidelines apply to pull requests that add a new documentation:
56		56
57	* 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. If a project doesn't have an official icon, it won't be accepted into DevDocs, sorry.	57	* 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. If a project doesn't have an official icon, it won't be accepted into DevDocs, sorry.
58	* DevDocs favors quality over quantity. Your documentation should only include API/reference documents that most developers may wish to read semi-regularly. By reducing the number of entries we make it easier to find other, more relevant entries. _(Note: you're more than welcome to submit pull requests removing seldom-used entries from existing documentations.)_	58	* 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.
59	* 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.).	59	* 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.).
60	* Names must be as short as possible and unique across the documentation.	60	* Names must be as short as possible and unique across the documentation.
61	* The number of types (categories) should ideally be less than 100.	61	* The number of types (categories) should ideally be less than 100.
@@ -71,7 +71,7 @@ To ask that an existing documentation be updated, please use the [Trello board]( · 9 unmodified lines
71		71
72	Besides new docs and features, here are other ways you can contribute:	72	Besides new docs and features, here are other ways you can contribute:
73		73
74	* Improve words and sentences. English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.	74	* Improve our copy. English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.
75	* Participate in the issue tracker. Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).	75	* Participate in the issue tracker. Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).
76		76
77	## Coding conventions	77	## Coding conventions

@@ -13,15 +13,15 @@ Keep track of development and community news: · 12 unmodified lines
13	* Subscribe to the [newsletter](http://eepurl.com/HnLUz)	13	* Subscribe to the [newsletter](http://eepurl.com/HnLUz)
14	* Join the [mailing list](https://groups.google.com/d/forum/devdocs)	14	* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
15		15
16	DevDocs is free and open source. If you like it, please consider funding the project on [Gratipay](https://gratipay.com/Thibaut/). Thanks!	16	DevDocs is free and open source. If you like it, please consider supporting my work on [Gratipay](https://gratipay.com/Thibaut/). Thanks!
17		17
18	Table of Contents: [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)	18	Table of Contents: [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)
19		19
20	## Quick Start	20	## Quick Start
21		21
22	Unless you want 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.	22	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.
23		23
24	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.	24	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.
25		25
26	DevDocs requires Ruby 2.2.0 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:	26	DevDocs requires Ruby 2.2.0 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:
27		27
@@ -43,17 +43,17 @@ The `thor docs:download` command is used to download/update individual documenta · 15 unmodified lines
43		43
44	DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.	44	DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.
45		45
46	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.	46	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.
47		47
48	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.	48	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.
49		49
50	## App	50	## App
51		51
52	The web app is all 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).	52	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).
53		53
54	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.	54	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.
55		55
56	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.	56	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.
57		57
58	DevDocs being a developer tool, the browser requirements are high:	58	DevDocs being a developer tool, the browser requirements are high:
59		59