Skip to content

Commit

Permalink
Added documentation about file path filter bar
Browse files Browse the repository at this point in the history
  • Loading branch information
darrenldl committed Jul 31, 2024
1 parent b518880 commit 712ce28
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,16 +338,25 @@ The default TUI is divided into four sections:
- Bottom pane consists of:
- Status bar
- Key binding info
- File path filter bar
- Search bar

File path filter bar consists of the file path filter status indicator and the
file path filter field.
The file path filter status indicator shows one of the following values:
- `OK`
- File path filter glob was applied successfully
- `ERR`
- Docfd failed to parse the glob in the field

Search bar consists of the search status indicator and the search field.
The search status indicator shows one of the following values:
- `OK`
- Docfd is idle/search is done
- `...`
- Docfd is still searching
- `ERR`
- Docfd failed to parse the search expression in the search field
- Docfd failed to parse the search expression in the field

#### Controls

Expand Down

0 comments on commit 712ce28

Please sign in to comment.