{"action":"created","comment":{"url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/comments/81093556","pull_request_review_id":2098033,"id":81093556,"diff_hunk":"@@ -6,49 +6,323 @@ nav_groups:\n nav_sort: 0\n ---\n \n-This is the home of `react-instantsearch`, a set of [React](https://facebook.github.io/react/) components to create unique instant-search experiences using [Algolia](https://www.algolia.com/) search engine.\n+## Welcome to react-instantsearch\n \n-**This is an alpha release, everything may be broken**.\n+React-instantsearch is the ultimate toolbox for creating instant search\n+experience using React.js and Algolia.\n \n-Links:\n-- [Chat with us](https://gitter.im/algolia/instantsearch.js) on gitter, we are active and waiting for feedback\n-- Code is at <https://github.com/algolia/instantsearch.js/tree/v2>, jump in\n+In this tutorial, you'll learn how to:\n \n+ - add react-instantsearch in your react project\n+ - bootstrap react-instantsearch\n+ - display results from Algolia\n+ - add components to filter the results\n+ - connect your own component to the search\n \n-## Example\n+## Before we start\n+\n+As mentionned earlier react-instantsearch is meant to be used with Algolia.\n+\n+Therefore, you'll need the credentials to an Algolia index. There are two\n+ways to follow this `getting started`:\n+ - using your own account with our dataset\n+ - using our demo index credentials\n+\n+If you want to use your account, you should have the folowing information:\n+ - `appId`, the application id\n+ - `searchKey`, the search key to your application\n+ - `indexName`, the name of the index in which you uploaded the data\n+\n+In case you just want to try the library here are the credentials for\n+our sample dataset:\n+ - `appId`: `latency` \n+ - `searchKey`: `3d9875e51fbd20c7754e65422f7ce5e1`\n+ - `indexName`: `bestbuy`\n+\n+This guide expects you to have a working react.js project. If\n+you want to start from scratch, we suggest you use\n+[create-react-app](https://github.com/facebookincubator/create-react-app#getting-started).","path":"docgen/src/gettingstarted.md","position":45,"original_position":45,"commit_id":"d26ab3986c9c3b0421291c9db33f7e36cf12746d","original_commit_id":"d26ab3986c9c3b0421291c9db33f7e36cf12746d","user":{"login":"bobylito","id":393765,"avatar_url":"https://avatars.githubusercontent.com/u/393765?v=3","gravatar_id":"","url":"https://api.github.com/users/bobylito","html_url":"https://github.com/bobylito","followers_url":"https://api.github.com/users/bobylito/followers","following_url":"https://api.github.com/users/bobylito/following{/other_user}","gists_url":"https://api.github.com/users/bobylito/gists{/gist_id}","starred_url":"https://api.github.com/users/bobylito/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bobylito/subscriptions","organizations_url":"https://api.github.com/users/bobylito/orgs","repos_url":"https://api.github.com/users/bobylito/repos","events_url":"https://api.github.com/users/bobylito/events{/privacy}","received_events_url":"https://api.github.com/users/bobylito/received_events","type":"User","site_admin":false},"body":"Maybe in the same way, we force our credentials, we should soft-force the use of create-react-app?","created_at":"2016-09-29T09:06:13Z","updated_at":"2016-09-29T09:06:13Z","html_url":"https://github.com/algolia/instantsearch.js/pull/1347#discussion_r81093556","pull_request_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347","_links":{"self":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/comments/81093556"},"html":{"href":"https://github.com/algolia/instantsearch.js/pull/1347#discussion_r81093556"},"pull_request":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347"}}},"pull_request":{"url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347","id":87149643,"html_url":"https://github.com/algolia/instantsearch.js/pull/1347","diff_url":"https://github.com/algolia/instantsearch.js/pull/1347.diff","patch_url":"https://github.com/algolia/instantsearch.js/pull/1347.patch","issue_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/1347","number":1347,"state":"open","locked":false,"title":"docs(getting-started): add a getting started guide to react-is doc","user":{"login":"bobylito","id":393765,"avatar_url":"https://avatars.githubusercontent.com/u/393765?v=3","gravatar_id":"","url":"https://api.github.com/users/bobylito","html_url":"https://github.com/bobylito","followers_url":"https://api.github.com/users/bobylito/followers","following_url":"https://api.github.com/users/bobylito/following{/other_user}","gists_url":"https://api.github.com/users/bobylito/gists{/gist_id}","starred_url":"https://api.github.com/users/bobylito/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bobylito/subscriptions","organizations_url":"https://api.github.com/users/bobylito/orgs","repos_url":"https://api.github.com/users/bobylito/repos","events_url":"https://api.github.com/users/bobylito/events{/privacy}","received_events_url":"https://api.github.com/users/bobylito/received_events","type":"User","site_admin":false},"body":"This PR is mainly done for providing the getting started. Along the way I had change / tweak a few things (that's why there are other files modified). Amongst the different other changes:\r\n - The sidebar contains the title of the page\r\n - The sidebar is smarter and adapts on the content of the navgroup or the document (if either of them contains only one element, this level is discarded)\r\n - The sidebar is a tad wider\r\n\r\nWhile the content of the getting started is mostly done, I need you:\r\n - can you review the [content itself](https://github.com/algolia/instantsearch.js/blob/d26ab3986c9c3b0421291c9db33f7e36cf12746d/docgen/src/gettingstarted.md), make sure I talked every important and I didn't go into too much details for others?\r\n - there is no live examples yet. The getting started of the helper have its samples on codepen, but I'm not sure we want to go this. What do you suggest?","created_at":"2016-09-28T16:00:51Z","updated_at":"2016-09-29T09:06:13Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f2052f8959f5e1972a4cfa77053c6293bdfd9590","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347/commits","review_comments_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347/comments","review_comment_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls/comments{/number}","comments_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/1347/comments","statuses_url":"https://api.github.com/repos/algolia/instantsearch.js/statuses/d26ab3986c9c3b0421291c9db33f7e36cf12746d","head":{"label":"algolia:v2-gettingstarted","ref":"v2-gettingstarted","sha":"d26ab3986c9c3b0421291c9db33f7e36cf12746d","user":{"login":"algolia","id":2034458,"avatar_url":"https://avatars.githubusercontent.com/u/2034458?v=3","gravatar_id":"","url":"https://api.github.com/users/algolia","html_url":"https://github.com/algolia","followers_url":"https://api.github.com/users/algolia/followers","following_url":"https://api.github.com/users/algolia/following{/other_user}","gists_url":"https://api.github.com/users/algolia/gists{/gist_id}","starred_url":"https://api.github.com/users/algolia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/algolia/subscriptions","organizations_url":"https://api.github.com/users/algolia/orgs","repos_url":"https://api.github.com/users/algolia/repos","events_url":"https://api.github.com/users/algolia/events{/privacy}","received_events_url":"https://api.github.com/users/algolia/received_events","type":"Organization","site_admin":false},"repo":{"id":39443258,"name":"instantsearch.js","full_name":"algolia/instantsearch.js","owner":{"login":"algolia","id":2034458,"avatar_url":"https://avatars.githubusercontent.com/u/2034458?v=3","gravatar_id":"","url":"https://api.github.com/users/algolia","html_url":"https://github.com/algolia","followers_url":"https://api.github.com/users/algolia/followers","following_url":"https://api.github.com/users/algolia/following{/other_user}","gists_url":"https://api.github.com/users/algolia/gists{/gist_id}","starred_url":"https://api.github.com/users/algolia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/algolia/subscriptions","organizations_url":"https://api.github.com/users/algolia/orgs","repos_url":"https://api.github.com/users/algolia/repos","events_url":"https://api.github.com/users/algolia/events{/privacy}","received_events_url":"https://api.github.com/users/algolia/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/algolia/instantsearch.js","description":":zap: UI library for high performance instant search experiences using Algolia","fork":false,"url":"https://api.github.com/repos/algolia/instantsearch.js","forks_url":"https://api.github.com/repos/algolia/instantsearch.js/forks","keys_url":"https://api.github.com/repos/algolia/instantsearch.js/keys{/key_id}","collaborators_url":"https://api.github.com/repos/algolia/instantsearch.js/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/algolia/instantsearch.js/teams","hooks_url":"https://api.github.com/repos/algolia/instantsearch.js/hooks","issue_events_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/events{/number}","events_url":"https://api.github.com/repos/algolia/instantsearch.js/events","assignees_url":"https://api.github.com/repos/algolia/instantsearch.js/assignees{/user}","branches_url":"https://api.github.com/repos/algolia/instantsearch.js/branches{/branch}","tags_url":"https://api.github.com/repos/algolia/instantsearch.js/tags","blobs_url":"https://api.github.com/repos/algolia/instantsearch.js/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/algolia/instantsearch.js/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/algolia/instantsearch.js/git/refs{/sha}","trees_url":"https://api.github.com/repos/algolia/instantsearch.js/git/trees{/sha}","statuses_url":"https://api.github.com/repos/algolia/instantsearch.js/statuses/{sha}","languages_url":"https://api.github.com/repos/algolia/instantsearch.js/languages","stargazers_url":"https://api.github.com/repos/algolia/instantsearch.js/stargazers","contributors_url":"https://api.github.com/repos/algolia/instantsearch.js/contributors","subscribers_url":"https://api.github.com/repos/algolia/instantsearch.js/subscribers","subscription_url":"https://api.github.com/repos/algolia/instantsearch.js/subscription","commits_url":"https://api.github.com/repos/algolia/instantsearch.js/commits{/sha}","git_commits_url":"https://api.github.com/repos/algolia/instantsearch.js/git/commits{/sha}","comments_url":"https://api.github.com/repos/algolia/instantsearch.js/comments{/number}","issue_comment_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/comments{/number}","contents_url":"https://api.github.com/repos/algolia/instantsearch.js/contents/{+path}","compare_url":"https://api.github.com/repos/algolia/instantsearch.js/compare/{base}...{head}","merges_url":"https://api.github.com/repos/algolia/instantsearch.js/merges","archive_url":"https://api.github.com/repos/algolia/instantsearch.js/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/algolia/instantsearch.js/downloads","issues_url":"https://api.github.com/repos/algolia/instantsearch.js/issues{/number}","pulls_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls{/number}","milestones_url":"https://api.github.com/repos/algolia/instantsearch.js/milestones{/number}","notifications_url":"https://api.github.com/repos/algolia/instantsearch.js/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/algolia/instantsearch.js/labels{/name}","releases_url":"https://api.github.com/repos/algolia/instantsearch.js/releases{/id}","deployments_url":"https://api.github.com/repos/algolia/instantsearch.js/deployments","created_at":"2015-07-21T12:10:27Z","updated_at":"2016-09-28T20:34:55Z","pushed_at":"2016-09-29T07:57:40Z","git_url":"git://github.com/algolia/instantsearch.js.git","ssh_url":"git@github.com:algolia/instantsearch.js.git","clone_url":"https://github.com/algolia/instantsearch.js.git","svn_url":"https://github.com/algolia/instantsearch.js","homepage":"https://community.algolia.com/instantsearch.js/","size":21382,"stargazers_count":1088,"watchers_count":1088,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":121,"mirror_url":null,"open_issues_count":113,"forks":121,"open_issues":113,"watchers":1088,"default_branch":"develop"}},"base":{"label":"algolia:v2","ref":"v2","sha":"4ad7e53c1580ab75538b7e3bdb51b73fa58850b9","user":{"login":"algolia","id":2034458,"avatar_url":"https://avatars.githubusercontent.com/u/2034458?v=3","gravatar_id":"","url":"https://api.github.com/users/algolia","html_url":"https://github.com/algolia","followers_url":"https://api.github.com/users/algolia/followers","following_url":"https://api.github.com/users/algolia/following{/other_user}","gists_url":"https://api.github.com/users/algolia/gists{/gist_id}","starred_url":"https://api.github.com/users/algolia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/algolia/subscriptions","organizations_url":"https://api.github.com/users/algolia/orgs","repos_url":"https://api.github.com/users/algolia/repos","events_url":"https://api.github.com/users/algolia/events{/privacy}","received_events_url":"https://api.github.com/users/algolia/received_events","type":"Organization","site_admin":false},"repo":{"id":39443258,"name":"instantsearch.js","full_name":"algolia/instantsearch.js","owner":{"login":"algolia","id":2034458,"avatar_url":"https://avatars.githubusercontent.com/u/2034458?v=3","gravatar_id":"","url":"https://api.github.com/users/algolia","html_url":"https://github.com/algolia","followers_url":"https://api.github.com/users/algolia/followers","following_url":"https://api.github.com/users/algolia/following{/other_user}","gists_url":"https://api.github.com/users/algolia/gists{/gist_id}","starred_url":"https://api.github.com/users/algolia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/algolia/subscriptions","organizations_url":"https://api.github.com/users/algolia/orgs","repos_url":"https://api.github.com/users/algolia/repos","events_url":"https://api.github.com/users/algolia/events{/privacy}","received_events_url":"https://api.github.com/users/algolia/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/algolia/instantsearch.js","description":":zap: UI library for high performance instant search experiences using Algolia","fork":false,"url":"https://api.github.com/repos/algolia/instantsearch.js","forks_url":"https://api.github.com/repos/algolia/instantsearch.js/forks","keys_url":"https://api.github.com/repos/algolia/instantsearch.js/keys{/key_id}","collaborators_url":"https://api.github.com/repos/algolia/instantsearch.js/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/algolia/instantsearch.js/teams","hooks_url":"https://api.github.com/repos/algolia/instantsearch.js/hooks","issue_events_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/events{/number}","events_url":"https://api.github.com/repos/algolia/instantsearch.js/events","assignees_url":"https://api.github.com/repos/algolia/instantsearch.js/assignees{/user}","branches_url":"https://api.github.com/repos/algolia/instantsearch.js/branches{/branch}","tags_url":"https://api.github.com/repos/algolia/instantsearch.js/tags","blobs_url":"https://api.github.com/repos/algolia/instantsearch.js/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/algolia/instantsearch.js/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/algolia/instantsearch.js/git/refs{/sha}","trees_url":"https://api.github.com/repos/algolia/instantsearch.js/git/trees{/sha}","statuses_url":"https://api.github.com/repos/algolia/instantsearch.js/statuses/{sha}","languages_url":"https://api.github.com/repos/algolia/instantsearch.js/languages","stargazers_url":"https://api.github.com/repos/algolia/instantsearch.js/stargazers","contributors_url":"https://api.github.com/repos/algolia/instantsearch.js/contributors","subscribers_url":"https://api.github.com/repos/algolia/instantsearch.js/subscribers","subscription_url":"https://api.github.com/repos/algolia/instantsearch.js/subscription","commits_url":"https://api.github.com/repos/algolia/instantsearch.js/commits{/sha}","git_commits_url":"https://api.github.com/repos/algolia/instantsearch.js/git/commits{/sha}","comments_url":"https://api.github.com/repos/algolia/instantsearch.js/comments{/number}","issue_comment_url":"https://api.github.com/repos/algolia/instantsearch.js/issues/comments{/number}","contents_url":"https://api.github.com/repos/algolia/instantsearch.js/contents/{+path}","compare_url":"https://api.github.com/repos/algolia/instantsearch.js/compare/{base}...{head}","merges_url":"https://api.github.com/repos/algolia/instantsearch.js/merges","archive_url":"https://api.github.com/repos/algolia/instantsearch.js/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/algolia/instantsearch.js/downloads","issues_url":"https://api.github.com/repos/algolia/instantsearch.js/issues{/number}","pulls_url":"https://api.github.com/repos/algolia/instantsearch.js/pulls{/number}","milestones_url":"https://api.github.com/repos/algolia/instantsearch.js/milestones{/number}","notifications_url":"https://api.github.com/repos/algolia/instantsearch.js/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/algolia/instantsearch.js/labels{/name}","releases_url":"https://api.github.com/repos/algolia/instantsearch.js/releases{/id}","deployments_url":"https://api.github.com/repos/algolia/instantsearch.js/deployments","created_at":"2015-07-21T12:10:27Z","updated_at":"2016-09-28T20:34:55Z","pushed_at":"2016-09-29T07:57:40Z","git_url":"git://github.com/algolia/instantsearch.js.git","ssh_url":"git@github.com:algolia/instantsearch.js.git","clone_url":"https://github.com/algolia/instantsearch.js.git","svn_url":"https://github.com/algolia/instantsearch.js","homepage":"https://community.algolia.com/instantsearch.js/","size":21382,"stargazers_count":1088,"watchers_count":1088,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":121,"mirror_url":null,"open_issues_count":113,"forks":121,"open_issues":113,"watchers":1088,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347"},"html":{"href":"https://github.com/algolia/instantsearch.js/pull/1347"},"issue":{"href":"https://api.github.com/repos/algolia/instantsearch.js/issues/1347"},"comments":{"href":"https://api.github.com/repos/algolia/instantsearch.js/issues/1347/comments"},"review_comments":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347/comments"},"review_comment":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/algolia/instantsearch.js/pulls/1347/commits"},"statuses":{"href":"https://api.github.com/repos/algolia/instantsearch.js/statuses/d26ab3986c9c3b0421291c9db33f7e36cf12746d"}}}}
{"actor":{"display_login":"bobylito"}}