Permalink
Fetching contributors…
Cannot retrieve contributors at this time
147 lines (95 sloc) 4.68 KB

Single Page Help Index

edit

This is the one page help document for Picky.

Search for things using your browser (use ⌘F).

Edit typos directly in the github page of a section using the edit button.

Getting started{#index-getting-started}

It's All Ruby. You'll never feel powerless. Look at your index data anytime.

Generating an app{#index-generating}

Creating an example app to get you up and running fast, Servers or Clients.

Generating them:

More infos on the applications:

Integration in Rails/Sinatra etc.{#index-integration}

How to integrate Picky in:

Tokenizing{#index-tokenizing}

How data is cut into little pieces for the index and when searching.

Indexes{#index-indexes}

How the data is stored and what you can do with Indexes.

Configuring an index:

How does data get into an index?

How is the data categorized?

How is the data prepared?

Getting at the data:

There are four different store types:

Advanced topics:

Searching{#index-searching}

How to configure a search interface over an index (or multiple).

What options does a user have when searching?

Advanced topics:

Facets{#facets-index}

When you need a slice over a category's data.

Results{#index-results}

What a picky search returns.

JavaScript{#index-javascript}

We include a JavaScript library to make writing snazzy interfaces easier – see the options.

Thanks{#index-thanks}

A bit of thanks!