Update README.md and CONTRIBUTING.md

Thibaut committed 12 years ago

Commit 8d5cb691 parent 8dffe972 files · +12 −14Browse files

Unified · Split

2 files

CONTRIBUTING.md +6 −8
README.md +6 −6

@@ -1,6 +1,6 @@
1	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. More time spent managing issues means less time spent improving DevDocs.
	3	+Wish to contribute? Great. Please review the following guidelines carefully and always search for existing issues before opening a new one.
4	4
5	5	Table of Contents:
6	6
@@ -31,7 +31,7 @@ For general feedback and ideas, please use the [mailing list](https://groups.goo · 24 unmodified lines
31	31
32	32	## Requesting new documentations
33	33
34		−Please do not open issues to request new documentations.
	34	+Please don't open issues to request new documentations.
35	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.
36	36
37	37	## Contributing code and features
@@ -54,18 +54,16 @@ See the [wiki](https://github.com/Thibaut/devdocs/wiki) to learn how to add new · 16 unmodified lines
54	54
55	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 a clean and official icon, in both 1x and 2x resolutions (16x16 and 32x32 pixels). This is important because icons are the only thing differentiating search results inside the app. 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.)_
	57	+* Your documentation must come with a clean and 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 are more than welcome to submit pull requests removing seldom-used entries from existing documentations.)_
59	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	60	* Names must be as short as possible and unique across the documentation.
61		−* The number of types (categories) must be less than 50.
62		−* It's ok to leave the CSS up to me.
	61	+* The number of types (categories) should ideally be less than 100.
63	62	* Don't modify the icon sprite. I'll do it after your pull request is merged.
64		−* Once your documentation is accepted into DevDocs, you'll be expected to maintain it on a regular basis.
65	63
66	64	## Updating existing documentations
67	65
68		−Please do not submit a pull request updating the version number of a documentation unless you have verified that it can be generated properly using the current code. Because the source will have changed, the code will likely need a few tweaks.
	66	+Please don't submit a pull request updating the version number of a documentation unless you have 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.
69	67
70	68	To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) or the [mailing list](https://groups.google.com/d/forum/devdocs).
71	69

README.md+6−6

@@ -11,7 +11,7 @@ Keep track of development and community news: · 10 unmodified lines
11	11	* Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
12	12	* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
13	13
14		−DevDocs is free and open source. If you use it and like it, please consider donating through [Gittip](https://www.gittip.com/Thibaut/) or [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4PTFAGT7K6QVG). Your support helps sustain the project and is highly appreciated.
	14	+DevDocs is free and open source. If you like it, please consider donating through [Gittip](https://www.gittip.com/Thibaut/) or [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4PTFAGT7K6QVG). Your support helps sustain the project and is highly appreciated.
15	15
16	16	Table of Contents: [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions)
17	17
@@ -19,7 +19,7 @@ DevDocs is free and open source. If you use it and like it, please consider dona · 1 unmodified line
19	19
20	20	Unless you wish to use DevDocs offline or contribute to the code, I recommend using the hosted version at [devdocs.io](http://devdocs.io). It's up-to-date and requires no setup.
21	21
22		−DevDocs is made of two separate pieces of software: a Ruby scraper responsible for generating the documentation files and indexes, and a JavaScript front-end powered by a small Sinatra app.
	22	+DevDocs is made of two separate pieces: a Ruby scraper responsible for generating the documentation files and indexes, and a JavaScript front-end powered by a small Sinatra app.
23	23
24	24	DevDocs requires Ruby 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:
25	25
@@ -34,15 +34,15 @@ Finally, point your browser at [localhost:9292](http://localhost:9292) (the firs · 8 unmodified lines
34	34
35	35	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`.
36	36
37		−Note: there is currently no update mechanism other than using git to update the code and `thor docs:download` to download the latest version of the docs. To stay informed about new versions, be sure to subscribe to the [newsletter](http://eepurl.com/HnLUz).
	37	+Note: there is currently no update mechanism other than using git 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 subscribe to the [newsletter](http://eepurl.com/HnLUz).
38	38
39	39	## Vision
40	40
41		−DevDocs aims to make reading and searching reference documentation fast, accessible and enjoyable. It aspires to become the “one stop shop” for all open-source software documentations.
	41	+DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.
42	42
43	43	The app's main goals are to: keep booting and loading 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; 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 by indexing only the minimum useful to most developers.
44	44
45		−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. Thus, tutorials, guides and other content that don't fit this requirement are outside the scope of the project.
	45	+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. Thus, tutorials, guides and other content that don't fit this requirement are outside the scope of the project.
46	46
47	47	## App
48	48
@@ -74,7 +74,7 @@ The scraper is responsible for generating the documentation and index files (met · 25 unmodified lines
74	74	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 given 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](http://nokogiri.org).
75	75
76	76	Modifications made to each document include:
77		−* removing stuff, such as the document structure (`<html>`, `<head>`, etc.), comments, empty nodes, etc.
	77	+* removing stuff such as the document structure (`<html>`, `<head>`, etc.), comments, empty nodes, etc.
78	78	* fixing links (e.g. to remove duplicates)
79	79	* replacing all external (not scraped) URLs with their fully qualified counterpart
80	80	* replacing all internal (scraped) URLs with their unqualified and relative counterpart