Skip to content

Commit 4be1765

Browse files
committed
docs: clarify purpose of preview window and scope of isd
In reference to #13
1 parent 9f50639 commit 4be1765

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/faq.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,25 @@ may help you if you have never added your account to your group.
5050
permission issues! Allowing your user to view the system journal
5151
is much less invasive and is the _correct_ way to fix the issue.
5252

53+
## Why are the features of the preview window so limited?
54+
55+
A different title could be:
56+
57+
> The preview window should support _X/Y/Z_.
58+
59+
Limiting the functionality of the preview window is an explicit design decision of `isd`.
60+
`isd` should be seen as the gateway to interact and work with `systemd` units while
61+
seamlessly integrating with other, purpose-built tools.
62+
By integrating with other tools, `isd` limits the scope of the application
63+
(reducing feature creep) and gives users full control since it is easy to configure
64+
your favorite pager/editor.
65+
66+
The main _goal_ of the preview window is to give quick feedback about the selected/highlighted
67+
units. But if you like to take a closer look at the output you should open the preview
68+
in a pager or editor. To open the pager you simply have to press ++enter++.
69+
70+
<!-- FUTURE: Add a few example pagers -->
71+
5372
## Why is `isd` so big?
5473

5574
At its core, `isd` is a Python application.

0 commit comments

Comments
 (0)