1
0
mirror of https://github.com/garraflavatra/rolens.git synced 2025-07-18 22:04:05 +00:00

Documentation website

This commit is contained in:
2023-06-01 22:06:51 +02:00
parent 415efe9ac4
commit 1ed8ca371b
35 changed files with 3979 additions and 8 deletions

View File

@ -0,0 +1,9 @@
---
title: Collections
parent: User guide
order: 30
---
You can use the following shortcuts when you have opened a collection.
{% render "shortcuts", shortcuts: shortcuts.collections %}

View File

@ -0,0 +1,6 @@
---
title: Aggregation
parent: Collections
order: 70
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Find items
parent: Collections
order: 20
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Indexes
parent: Collections
order: 60
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Insert items
parent: Collections
order: 30
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Remove items
parent: Collections
order: 50
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Stats
parent: Collections
order: 10
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Update items
parent: Collections
order: 40
stub: true
---

View File

@ -0,0 +1,6 @@
---
title: Databases
parent: User guide
order: 20
stub: true
---

6
docs/user-guide/hosts.md Normal file
View File

@ -0,0 +1,6 @@
---
title: Managing hosts
parent: User guide
order: 10
stub: true
---

View File

@ -0,0 +1,16 @@
---
title: Logfiles
parent: User guide
order: 120
---
Rolens keeps track of log-worthy events and logs them in its log directory.
* Windows: `~/AppData/Local/Rolens/Logs`
* Mac: `~/Library/Logs/Rolens`
* Linux: `~/.config/rolens/logs`
In those directories, you can find the following files:
* `rolens.log`: This is the main log file which is a chronological stream of events such as frontend errors, connection problems et cetera.
* `environment.json`: This file contains information about your environment that could be useful while debugging.

View File

@ -0,0 +1,14 @@
---
title: Preferences
parent: User guide
order: 100
---
You can open the preference panel by using the menu <kbd>Rolens > Settings…</kbd> or by typing {% render "shortcut", shortcut: shortcuts.preferences[0] %}.
Rolens currently offers the following configuration options:
* The initial number of items to retrieve using one query (query limit).
* The default sorting criteria. Defaults to `{ "_id": 1 }`, i.e. sort by the `_id` field ascending.
* Whether to auto-submit the query when a collection has been opened.
* The default directory where exports should be saved.