Skip to content

Commit

Permalink
+ edit links for all the doc sections
Browse files Browse the repository at this point in the history
  • Loading branch information
floere committed Nov 1, 2012
1 parent e54419f commit d242249
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 0 deletions.
3 changes: 3 additions & 0 deletions web/source/documentation/_api.html.md
@@ -1,5 +1,8 @@
## API Docs ## 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 For documentation on how to configure Picky, see


[Server API docs](doc/server/index.html) and [Client API docs](doc/client/index.html) [Server API docs](doc/server/index.html) and [Client API docs](doc/client/index.html)
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_facets.html.md
@@ -1,5 +1,8 @@
## Facets ## 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. 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. In Picky, categories are explicit slices over your index data. Picky facets are implicit slices over your category data.
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_generators.html.md
@@ -1,5 +1,8 @@
## Generators{#generators} ## 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). 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 Or, run gem install
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_help.html.md
@@ -1,5 +1,8 @@
### Help? ### 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). 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! Best of success!
3 changes: 3 additions & 0 deletions web/source/documentation/_index.html.md
@@ -1,5 +1,8 @@
## Single Page Help Index ## 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. This is the one page help document for Picky.


Search for things using your browser (use ⌘F). Search for things using your browser (use ⌘F).
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_indexes.html.md
@@ -1,5 +1,8 @@
## Indexes{#indexes} ## Indexes{#indexes}


{.edit}
[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_indexes.html.md)

Indexes do three things: Indexes do three things:


* Define where the data comes from. * Define where the data comes from.
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_integration.html.md
@@ -1,5 +1,8 @@
## Integration ## Integration


{.edit}
[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_integration.html.md)

How do you integrate Picky in…? How do you integrate Picky in…?


### Rails ### Rails
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_results.html.md
@@ -1,5 +1,8 @@
## Results{#results} ## Results{#results}


{.edit}
[edit](http://github.com/floere/picky/blob/master/web/source/documentation/_results.html.md)

Results are returned by the `Search` instance. Results are returned by the `Search` instance.


books = Search.new books_index do books = Search.new books_index do
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_search.html.md
@@ -1,5 +1,8 @@
## Search{#search} ## 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. Picky offers a `Search` interface for the indexes. You instantiate it as follows.


Just searching over one index: Just searching over one index:
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_servers.html.md
@@ -1,5 +1,8 @@
## Servers / Applications{#servers} ## 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*. 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. This means you can have a Picky server running in a DRb instance if you want to. Or in irb, for example.
Expand Down
3 changes: 3 additions & 0 deletions web/source/documentation/_thanks.html.md
@@ -1,3 +1,6 @@
### Thanks! ### 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. Thanks to whoever made the [Sinatra README page](http://www.sinatrarb.com/intro) for the inspiration.
3 changes: 3 additions & 0 deletions web/source/documentation/_tokenizing.html.md
@@ -1,5 +1,8 @@
## Tokenizing{#tokenizing} ## 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 `indexing` method in an `Index` describes how *index data* is handled.


The `searching` method in a `Search` describes how *queries* are handled. The `searching` method in a `Search` describes how *queries* are handled.
Expand Down

0 comments on commit d242249

Please sign in to comment.