Permalink
Browse files

+ edit links for all the doc sections

  • Loading branch information...
floere committed Nov 1, 2012
1 parent e54419f commit d242249e4e5db8b7a216e64390f9aa5a0677e7bd
@@ -1,5 +1,8 @@
## API Docs
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_api.html.md)
+
For documentation on how to configure Picky, see
[Server API docs](doc/server/index.html) and [Client API docs](doc/client/index.html)
@@ -1,5 +1,8 @@
## Facets
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_facets.html.md)
+
Here's [the Wikipedia entry on facets](http://en.wikipedia.org/wiki/Faceted_classification). I fell asleep after about 5 words. Twice.
In Picky, categories are explicit slices over your index data. Picky facets are implicit slices over your category data.
@@ -1,5 +1,8 @@
## Generators{#generators}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_generators.html.md)
+
Picky offers a few generators to have a running server and client up in 5 minutes. Please follow the [Getting Started](getting_started.html).
Or, run gem install
@@ -1,5 +1,8 @@
### Help?
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_help.html.md)
+
If neither the docs, nor the Wiki, nor the single page help has helped, feel free to contact us [through the methods described on the about page](index.html).
Best of success!
@@ -1,5 +1,8 @@
## Single Page Help Index
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_index.html.md)
+
This is the one page help document for Picky.
Search for things using your browser (use ⌘F).
@@ -1,5 +1,8 @@
## Indexes{#indexes}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_indexes.html.md)
+
Indexes do three things:
* Define where the data comes from.
@@ -1,5 +1,8 @@
## Integration
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_integration.html.md)
+
How do you integrate Picky in…?
### Rails
@@ -1,5 +1,8 @@
## Results{#results}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_results.html.md)
+
Results are returned by the `Search` instance.
books = Search.new books_index do
@@ -1,5 +1,8 @@
## Search{#search}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_search.html.md)
+
Picky offers a `Search` interface for the indexes. You instantiate it as follows.
Just searching over one index:
@@ -1,5 +1,8 @@
## Servers / Applications{#servers}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_servers.html.md)
+
Picky, from version 3.0 onwards, is designed to run *anywhere*, *in anything*.
This means you can have a Picky server running in a DRb instance if you want to. Or in irb, for example.
@@ -1,3 +1,6 @@
### Thanks!
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_thanks.html.md)
+
Thanks to whoever made the [Sinatra README page](http://www.sinatrarb.com/intro) for the inspiration.
@@ -1,5 +1,8 @@
## Tokenizing{#tokenizing}
+{.edit}
+[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_tokenizing.html.md)
+
The `indexing` method in an `Index` describes how *index data* is handled.
The `searching` method in a `Search` describes how *queries* are handled.

0 comments on commit d242249

Please sign in to comment.