diff options
Diffstat (limited to 'packages/gitbook-plugin-search/src/actions/search.js')
| -rw-r--r-- | packages/gitbook-plugin-search/src/actions/search.js | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/packages/gitbook-plugin-search/src/actions/search.js b/packages/gitbook-plugin-search/src/actions/search.js index b4f811e..c71eda2 100644 --- a/packages/gitbook-plugin-search/src/actions/search.js +++ b/packages/gitbook-plugin-search/src/actions/search.js @@ -2,6 +2,14 @@ const { Promise, Immutable } = require('gitbook-core'); const { List } = Immutable; const TYPES = require('./types'); +/* + Search workflow: + + 1. Typing in the search input + 2. Trigger an update of the url + 3. An update of the url, trigger an update of search results + */ + /** * Start a search query * @param {String} q @@ -13,7 +21,6 @@ function query(q) { }; } - /** * Update results for a query * @param {String} q |