Skip to content

Commit

Permalink
docs: Update README.md and reference it on About page
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikolay-Lysenko committed Feb 24, 2024
1 parent c6c692b commit 6fb0d72
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Features of the search system include:
- [x] Separate spaces for fields of knowledge
- [x] Search by single tag
- [x] Search by expressions consisting of tags, logical operators, and parentheses
- [ ] Full-text search with TF-IDF
- [x] Full-text search with TF-IDF
- [ ] Search within kNN-index built on vector representations of notes

The repository can be used either as a whole (with notes written by me) or as a Python package providing an interface to your notes.
Expand Down Expand Up @@ -61,6 +61,7 @@ All cells of a notebook must be Markdown cells starting with '## {title}'. To ta
So far so good. The knowledge base is ready, but the app must be configured to use it. Create somewhere a JSON file that looks like this:
```json
{
"LANGUAGE": "en",
"FIELDS": ["field_one", "field_two"],
"FIELD_TO_ALIAS": {"field_one": "Field #1", "field_two": "Field #2"},
"FIELD_TO_SEARCH_PROMPT": {"field_one": "the_most_popular_tag", "field_two": "the_most_popular_tag"},
Expand All @@ -80,16 +81,17 @@ All that remains is to launch the app:
python -m readingbricks -c /absolute/path/to/config.json
```

As in the previous section, go to `127.0.0.1:5000`. Known bug is that some minor interface elements are in Russian regardless of notes language. I am still seeking an elegant solution to this problem.
As in the previous section, go to `127.0.0.1:5000`. Known bug is that some minor interface elements are in Russian regardless of notes language. I am still seeking an elegant and maintainable solution to this problem.

## Interface guide

The web interface is quite self-explanatory.

At the index page, you can select a filed and go to its home page. Such home pages have two control elements:
* search bar,
* cloud of tags.
The only non-trivial control element is search bar which is located at home pages of fields. It can operate in three modes:
* query in natural language (e.g., `transformers in recommender systems`),
* query as expression consisting of tags, logical operators, and parentheses — special keyword `tags:` is required (e.g. `tags: transformers AND recommender_systems`),
* combination of above options — symbols before `tags:` form natural query and symbols after it form tag expression (e.g., `transformers tags: recommender_systems`).

You can look through the tag cloud and choose the tags you are interested in. If you are interested in a single tag, just push a button with it. However, if you need less trivial selection of notes, search bar should be used. Arbitrary logical expressions with AND, OR, and NOT operators, and parentheses are supported there.
If at least part of a query is in natural language, results are sorted by TF-IDF. Else, order of results depends on lexicographic positions of their notebooks within their field directory and on positions of cells within notebooks.

Enjoy reading!
2 changes: 1 addition & 1 deletion readingbricks/templates/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<div id="central">
<div id="contents">
<h2>Обзор интерфейса</h2>
<p>Когда-нибудь он будет написан... А пока можно обратиться к <a href="https://github.com/Nikolay-Lysenko/readingbricks/blob/master/README.md">README.md</a> из GitHub-репозитория этого проекта.</p>
<p>Когда-нибудь он будет написан... А пока можно обратиться к <a href="https://github.com/Nikolay-Lysenko/readingbricks/blob/master/README.md#interface-guide">README.md</a> из GitHub-репозитория этого проекта.</p>
</div>
</div>
</body>
Expand Down

0 comments on commit 6fb0d72

Please sign in to comment.