Skip to content

Commit

Permalink
Added a stub of documentation to reveal the Controller model to users…
Browse files Browse the repository at this point in the history
…. Linked to ThinkingSphinx models that might be helpful for reference until there is documentation.
  • Loading branch information
Joe Marty committed Feb 21, 2012
1 parent 846c6da commit ba46610
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion riddle/getting_started.textile
Expand Up @@ -62,4 +62,8 @@ Documentation lacking (although this feature is only for Sphinx 0.9.9, so maybe

h3. Configuration

Documentation lacking, but Riddle's configuration objects mirror Sphinx's, so it should be pretty easy to figure out.
Documentation lacking, but Riddle's configuration objects mirror Sphinx's, so it should be pretty easy to figure out. Some of its usage can also be inferred by studying the Configuration model in "ThinkingSphinx":https://github.com/freelancing-god/thinking-sphinx/ .

h3. Controller

Riddle's controller object allows you to control the operation of sphinx (starting, stopping, indexing...) in ruby. Documentation is lacking, but some of its usage can be inferred by studying the Test and Configutation models in "ThinkingSphinx":https://github.com/freelancing-god/thinking-sphinx/ .

0 comments on commit ba46610

Please sign in to comment.