Permalink
Browse files

+ documentation

  • Loading branch information...
1 parent 70fc4ad commit 02f3dd302749da0a9bb28bbe007586d68974906e @floere committed Oct 29, 2012
@@ -44,6 +44,6 @@ Picky currently offers an example Sinatra client that you can adapt for your pro
This client is generated with
- picky generate sinatra_client target_directory
+ picky generate client target_directory
and generates a full Sinatra client (including Javascript etc.) that you can try immediately. Just follow the instructions.
@@ -1,7 +1,7 @@
## All Ruby
{.edit}
-[Edit](http://github.com/floere/picky/blob/master/web/source/documentation/_intro.html.md)
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_intro.html.md)
Never forget this: *Picky is all Ruby, all the time*!
@@ -2,99 +2,140 @@
This is the one page help document for Picky.
-Search for things using your browser (eg. ⌘F).
+Search for things using your browser (use ⌘F).
-Edit typos directly in the [github page](#todo) using the edit button.
+Edit typos directly in the [github page](http://github.com/floere/picky/tree/master/web/source/documentation) of a section using the [edit](http://github.com/floere/picky/blob/master/web/source/documentation/_linkage.html.md) button.
-### Getting started
+### Getting started{#index-getting-started}
It's [All Ruby](#all_ruby). [Transparency](#transparency) matters.
-#### Generating an app
+#### Generating an app{#index-generating}
Creating an example app to get you up and running fast.
-[Generators](#generators)
- * [Servers](#generators-servers)
- * [Sinatra](#generators-servers-sinatra)
- * [All In One](#generators-servers-allinone)
- * [Clients](#generators-clients)
- * [Sinatra](#generators-clients-sinatra)
-* [Servers / Applications](#servers)
- * [Sinatra Style](#servers-sinatra)
- * [Routing](#servers-sinatra-routing)
- * [Logging](#servers-sinatra-logging)
- * [All In One (Client + Server)](#servers-allinone)
+Picky offers a number of [Generators](#generators).
-#### Integration in Rails/Sinatra etc.
+Two [Servers](#generators-servers):
+[Sinatra](#generators-servers-sinatra) &
+[Server+Client in one](#generators-servers-allinone)
+
+One [Client](#generators-clients):
+[Sinatra](#generators-clients-sinatra)
+
+The three example [Applications](#servers) are:
+[Sinatra](#servers-sinatra)
+(
+[Routing](#servers-sinatra-routing),
+[Logging](#servers-sinatra-logging)
+)
+&
+[All In One (Client/Server)](#servers-allinone)
+
+#### Integration in Rails/Sinatra etc.{#index-integration}
Picky in various environments.
-[Rails](#rails)
-[Sinatra](#sinatra)
-[DRb](#drb)
-[Ruby Script](#rubyscript)
+* [Rails](#rails)
+* [Sinatra](#sinatra)
+* [DRb](#drb)
+* [Ruby Script](#rubyscript)
### Tokenizing{#index-tokenizing}
How data is cut into little pieces for the index and when searching.
-[Tokenizing](#tokenizing)
-[Options](#tokenizing-options)
-[Tokenizer](#tokenizing-tokenizer)
-[Examples](#tokenizing-examples)
-[Notes](tokenizing-notes)
-
-### Indexes
-
-[Indexes](#indexes)
-
-There are four different [types](#indexes-types):
-[Memory](#indexes-types-memory),
-[Redis](#indexes-types-redis),
-[SQLite](#indexes-types-sqlite), and
-[File](#indexes-types-file)
-
-[Accessing](#indexes-acessing)
- * [Configuration](#indexes-configuration)
- * [Data Sources](#indexes-sources)
- * [Responding to #each](#indexes-sources-each)
- * [Delayed](#indexes-sources-delayed)
- * [Classic Style](#indexes-sources-classic)
- * [Indexing / Tokenizing](#indexes-indexing)
- * [Categories](#indexes-categories)
- * [Option partial](#indexes-categories-partial)
- * [Option weights](#indexes-categories-weights)
- * [Option similarity](#indexes-categories-similarity)
- * [Option qualifier / qualifiers (categorizing)](#indexes-categories-qualifiers)
- * [Option from](#indexes-categories-from)
- * [Option key_format](#indexes-categories-keyformat)
- * [Option source](#indexes-categories-source)
- * [Searching](#indexes-categories-searching)
- * [Key Format (Format of the indexed Ids)](#indexes-keyformat)
- * [Identifying in Results](#indexes-results)
- * [Indexing](#indexes-indexing)
- * [Reloading](#indexes-reloading)
- * [Using signals](#indexes-reloading-signals)
- * [Reindex](#indexes-reindexing)
-
-### Searching
-
-How to search over indexes.
-
-* [Search](#search)
- * [Options](#search-options)
- * [Searching / Tokenizing](#search-options-searching)
- * [Boost](#search-options-boost)
- * [Ignore Categories](#search-options-ignore)
- * [Ignore Unassigned Tokens](#search-options-unassigned)
- * [Maximum Allocations](#search-options-maxallocations)
- * [Early Termination](#search-options-terminateearly)
-
-#### Results
+* [What is tokenizing?](#tokenizing)
+* [Options](#tokenizing-options)
+* [Using a custom tokenizer](#tokenizing-tokenizer)
+* [Examples](#tokenizing-examples)
+* [Advanced tokenizing](#tokenizing-notes)
+
+### Indexes{#index-indexes}
+
+How the data is stored and what you can do with [Indexes](#indexes).
+
+Configuring an index:
+
+* [Configuration](#indexes-configuration)
+
+How does data get in there?
+
+* [Indexing](#indexes-indexing)
+* [Data Source Overview](#indexes-sources)
+* [Source responding to #each](#indexes-sources-each)
+* [Classic Picky sources (soon deprecated)](#indexes-sources-classic)
+* [When is the data for indexing loaded?](#indexes-sources-delayed)
+
+How is the data categorized?
+
+* [Categories](#indexes-categories)
+* [Option partial](#indexes-categories-partial)
+* [Option weights](#indexes-categories-weights)
+* [Option similarity](#indexes-categories-similarity)
+* [Option qualifier / qualifiers (categorizing)](#indexes-categories-qualifiers)
+* [Option from](#indexes-categories-from)
+* [Option key_format](#indexes-categories-keyformat)
+* [Option source](#indexes-categories-source)
+
+How is the data prepared?
+
+* [Indexing / Tokenizing](#indexes-indexing)
+
+Getting at the data:
+
+* [Accessing indexes and categories](#indexes-acessing)
+
+There are four different [store types](#indexes-types):
+
+* [Memory](#indexes-types-memory)
+* [Redis](#indexes-types-redis)
+* [SQLite](#indexes-types-sqlite)
+* [File](#indexes-types-file)
+
+Advanced topics:
+
+* [Format of the indexed ids](#indexes-keyformat)
+* [Reloading](#indexes-reloading)
+* [Reindexing](#indexes-reindexing)
+* [Using signals](#indexes-reloading-signals)
+* [Which index did a result come from?](#indexes-results)
+
+### Searching{#index-searching}
+
+How to configure a search interface over an index (or multiple).
+
+* [Search Interface Overview](#search)
+* [Search Options](#search-options)
+* [Searching / Tokenizing](#search-options-searching)
+
+What [options](#indexes-categories-searching) does a user have when searching?
+
+Advanced topics:
+
+* [Boosting](#search-options-boost) ([boosting a single category](#indexes-categories-weights))
+* [Ignoring a category](#search-options-ignore)
+* [Ignoring query words that are not found](#search-options-unassigned)
+* [Maximum Allocations](#search-options-maxallocations)
+* [Stopping a search early](#search-options-terminateearly)
+
+#### Facets{#facets-index}
+
+When you need a slice over a category's data.
+
+* [Facets](#facets)
+* [Index Facets](#index_facets)
+* [Search Facets](#search_facets) (Using a query to filter your index facets)
+
+#### Results{#index-results}
What a picky search returns.
-[Results](#results)
- * [Logging](#results-logging)
- * [Sorting](#results-sorting)
+* [Results Overview](#results)
+* [Logging](#results-logging)
+* [Sorting](#results-sorting)
+* [Identification](#indexes-results)
+
+### Thanks{#index-thanks}
+
+A bit of [thanks](#thanks)!

0 comments on commit 02f3dd3

Please sign in to comment.