Skip to content
This repository was archived by the owner on Nov 16, 2024. It is now read-only.

Commit f301dd3

Browse files
committed
Update docs
More features Add Examples
1 parent 89d5c87 commit f301dd3

10 files changed

+68
-6
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ StackUp Campaign: [ChromaDB Essentials: From Theory to Application](https://earn
66

77
Juris FastSearch is a legal case retrieval solution for the legal community to quickly and efficiently seach and retrieve relevant law cases and citations for their current case.
88

9+
![Overview](docs/imgs/Overview.png)
10+
911
#### Problem
1012

1113
Currently, it is tedious for law professionals to prepare for their cases as they have to manually look for precedence or similar cases as part of their legal research. With advancement of Artificial Intelligence (AI), ChatGPT maybe a tempting solution to quickly resovle that. However, AI solutions are prone to "hallucinations", making up fake cases which may appear to support the user's case, as it has already [happened before](https://www.forbes.com/sites/mollybohannon/2023/06/08/lawyer-used-chatgpt-in-court-and-cited-fake-cases-a-judge-is-considering-sanctions/).
@@ -14,13 +16,13 @@ Juris FastSearch is able to quickly provide references without any risk of "hall
1416

1517
#### Features & Usage
1618

17-
[Key Features](docs/Features.md)
19+
Some of our [key features](docs/Features.md) include document-backed results, downloadable documents and instant document viewer.
1820

19-
Can't wait to try out Juris FastSearch? Check out the [installation guide](docs/Installation.md) to get started!
21+
Can't wait to try out Juris FastSearch? Check out the [installation guide](docs/Installation.md) to get started! We have also provided some [examples](docs/Examples.md) to demostrate to you how to use Juris FastSearch.
2022

2123
#### Disclaimer
2224

2325
> [!NOTE]
24-
> This is a proof of concept for the purpose of [_Bounty: Advanced Image and Data Retrieval System Using ChromaDB_](https://earn.stackup.dev/campaigns/chromadb-essentials-from-theory-to-application/quests/bounty-advanced-image-and-data-retrieval-system-using-chromadb-48ba).
26+
> This is a proof of concept for the purpose of [_Bounty: Advanced Image and Data Retrieval System Using ChromaDB_](https://earn.stackup.dev/campaigns/chromadb-essentials-from-theory-to-application/quests/bounty-advanced-image-and-data-retrieval-system-using-chromadb-48ba)
2527
2628
As part of our concept, some cases are downloaded from [CourtListener](https://www.courtlistener.com).

docs/Examples.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Examples
2+
3+
For example, you want to search for "Election votes".
4+
5+
1. Click on the search box, type "Elections votes"
6+
2. Click on **Search** at the bottom right on the search box
7+
8+
> [!TIP]
9+
> You can click [Shift] + [Enter] to search without needing your hands to leave the keyboard
10+
11+
![Example search using words election votes](imgs/Example-elections-votes.png)
12+
13+
## View document
14+
15+
For example, you have searched "Election votes" and wants to look at the document of the second result.
16+
17+
1. Under the _Results_ section, click on _14-556 Obergefell v. Hodges.pdf_ (2nd result)
18+
2. Observe the the document viewer has updated to show the new document
19+
20+
![Example view second search result](imgs/Example-view-document.png)
21+
22+
## Download document
23+
24+
You want to download the document _08-205 Citizens United v. Federal Election Comm'n.pdf_.
25+
26+
1. Under the _Results_ section, beside _08-205 Citizens United v. Federal Election Comm'n.pdf_, click on "954.4 KB ⇣"
27+
28+
![Example download document](imgs/Example-download-document.png)
29+
30+
31+
## Change number of results to display
32+
33+
For example, you want the search to display four results.
34+
35+
1. Expand the _Preferences_ section
36+
2. Click on the textbox for "Number of Results" and change to "4"
37+
38+
![Example change results count to four](imgs/Example-change-results-count.png)

docs/Features.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,42 @@
22

33
## Document-backed Results
44

5-
Each result is a reference file that we found to be relavent to you.
5+
Each result is a reference file that we found to be relavent to you. The results are ordered with the highest relevance at the top.
66

77
![Image of results with red box highlighting the files](imgs/Results-box-files.png)
8+
> Red box indicates the list of documents found to be relevant
89
910
## Easy Download
1011

11-
You can easily download the reference file by clicking the download link provided along with the file names.
12+
You can easily download the reference document by clicking the download link provided along with the file names.
13+
14+
The file size is also shown for the user's information and decision on whether to download the document.
1215

1316
![Image of results with red box highlighting the download for the files](imgs/Results-box-download.png)
17+
> Red box indicates the file size of each document, and can be clicked to download
1418
1519
## Build-in Viewer
1620

1721
You can also quickly glance at the contents of the files to determine that is it useful for you before choose to download the files.
1822

1923
Simply click on the file name and the build-in viewer will display the file.
24+
At the bottom of the viewer, you can click :arrow_left: and :arrow_right: to move flip the pages of the document.
25+
Additionally, you can click on the current page number at the bottom and type in the page number to go to.
26+
27+
![Build-in viewer to view PDF files](imgs/Build-in-viewer.png)
28+
29+
## Performance
30+
31+
You can better understand how to application is doing by looking at its performance.
32+
33+
This section is opened by default, and can be hidden by the user if deemed not useful.
34+
35+
![Performance section](imgs/Performance.png)
36+
37+
## Preferences
38+
39+
There are also some preferences you can set.
40+
41+
This section is closed by default, and can be opened to modify the preferences.
2042

21-
![Build-in viewer to view PDF files](imgs/Build-in-viewer.png)
43+
![References section](imgs/Preferences.png)
47.3 KB
Loading
250 KB
Loading

docs/imgs/Example-elections-votes.png

189 KB
Loading

docs/imgs/Example-view-document.png

190 KB
Loading

docs/imgs/Overview.png

43.8 KB
Loading

docs/imgs/Performance.png

10.6 KB
Loading

docs/imgs/Preferences.png

4.53 KB
Loading

0 commit comments

Comments
 (0)