Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create introduction pages for "Guide" "Components" "Connectors" #1468

Closed
vvo opened this issue Oct 25, 2016 · 0 comments
Closed

Create introduction pages for "Guide" "Components" "Connectors" #1468

vvo opened this issue Oct 25, 2016 · 0 comments
Assignees
@bobylito
Labels
Doc: API

Comments

@vvo
Copy link
Contributor

vvo commented Oct 25, 2016

Right now:

  • click Guide => Styling is shown
  • click Components => Hits is shown
  • click Connectors => connectHits is shown

This can misleading and surprising, we would be better having some introduction page explaining what are the goals and use of each section.

"In this guide you will learn about beginner and advanced concepts and use case.."

"Widgets are our pre-styled pre-connected search widgets..., difference with connectors, when to use a widget, how to use a widget"

"Connectors are HOC, when to use a connector, differences wit widgets.., how to use a connector"

Those small draft are just ideas, we do not need to be very descriptive but at least we need them
@vvo vvo added this to the react-instantsearch first release milestone Oct 25, 2016
@bobylito bobylito self-assigned this Oct 26, 2016
bobylito pushed a commit that referenced this issue Oct 26, 2016
doc(orga): Add intro pages to connector, component and guides
3bdaadc 
Also:
 - auto generate the example page
 - fix some styling
 - moved guides into a folder

Fix #1468
@bobylito bobylito mentioned this issue Oct 26, 2016
Merged
vvo pushed a commit that referenced this issue Oct 27, 2016
@bobylito @vvo
doc(orga): Add intro pages to connector, component and guides (#1476)
4d06cb7 
* doc(orga): Add intro pages to connector, component and guides

Also:
 - auto generate the example page
 - fix some styling
 - moved guides into a folder

Fix #1468

* doc(examples): add source metadata
@vvo vvo closed this as completed Nov 2, 2016
@renovate renovate bot mentioned this issue Feb 2, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bobylito bobylito

Labels
Doc: API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vvo @bobylito