Documentation website

docs/colophon.md

@@ -0,0 +1,11 @@
+---
+title: Colophon
+order: 900
+---
+
+Rolens is © [Romein van Buren](mailto:romein@vburen.nl) 2023. The source code and compiled binaries are released under the GNU GPLv3 license — see [`LICENSE`](https://github.com/garraflavatra/rolens/blob/main/LICENSE) for the full license text.
+
+## Credits
+
+* Icons are from [Feather Icons](https://feathericons.com/) by [Cole Bemis](https://github.com/colebemis).
+* Vector drawings come from [unDraw](https://undraw.co/).

docs/index.md

@@ -0,0 +1,20 @@
+---
+title:
+order: 1
+summary: Robust, blazing-fast, comprehensive, yet simple [MongoDB](https://www.mongodb.com/) administration tool for Windows, macOS and Linux.
+eleventyNavigation:
+  title: Home
+---
+
+This project arose from all flaws of similar tools many of which are slow, complicated, heavy, and fairly unwieldy. They mostly require a reasonably high level of knowledge on how to operate the program.
+
+**Rolens aims to be the intuitive, lightweight counterpart of these overengineered tools.**
+
+- **Lightweight**: Rolens weighs about 15 MB.
+- **Open source**: You know what's inside!
+- **Low overhead**: Typical query results against a local database are returned whithin milliseconds.
+- **Intuitive interface**: You know MongoDB? You know Rolens.
+
+![Impression of Rolens's interface](./images/home-impression.png)
+
+This project is heavily inspired by the excellent [MongoHub](https://github.com/bububa/MongoHub-Mac) application, which sadly has not been updated since 2011.

docs/installation.md

@@ -1,4 +1,7 @@
-# Installing Rolens
+---
+title: Installation
+order: 20
+---
 
 ## System requirements
 
@@ -15,12 +18,14 @@ You can obtain a pre-compiled Rolens binary for macOS or installer for Windows f
 
 ## From source
 
-Rolens is open-source software, which means that you can compile it from source on your own machine by cloning [the repository](https://github.com/garraflavatra/rolens) and running `make`.
+Rolens is open-source software, which means that you can compile it from source on your own machine by cloning [the repository](https://github.com/garraflavatra/rolens).
 
 ### Prerequisites
 
 Rolens is written in Go, so you should download the Go compiler from [the download page](https://go.dev/dl/). The minimum version required is 1.18. You can confirm whether it's installed correctly by running `go version` and checking that it outputs something similar to `go1.18.2`.
 
+Furthermore, you need to have [Wails ^3.1](https://wails.io/docs/gettingstarted/installation) installed: `go install github.com/wailsapp/wails/v2/cmd/wails@latest`.
+
 In order to compile the frontend, [Node.js](https://nodejs.org/en/download) ^16.0 and the [npm](https://npmjs.com) package manager ^8.0 (included in Node.js) are required. To confirm the installed versions of those tools, execute `node -v` and `npm -v`.
 
 ### Download source
@@ -28,8 +33,13 @@ In order to compile the frontend, [Node.js](https://nodejs.org/en/download) ^16.
 To obtain a copy of the source code, do either of the following:
 
 * Download a tarball or zip archive from the [release page](https://github.com/garraflavatra/rolens/releases/latest). Make sure you download the source archive, and not a pre-compiled binary.
-* Or clone [the Git repository](https://github.com/garraflavatra/rolens): `git clone git clone https://github.com/garraflavatra/rolens.git`.
+* Or clone [the Git repository](https://github.com/garraflavatra/rolens): `git clone https://github.com/garraflavatra/rolens.git`.
 
 ### Compile
 
-`cd` into the root directory of the source code and run `make`. The generated binary will live in `build/bin`. You may want to run the installer (Windows) or move the app to the Applications folder (Mac).
+`cd` into the root directory of the source code and run either:
+
+* `wails build` to generate an executable for your platform.
+* `wails build -nsis` to generate an [NSIS installer](https://nsis.sourceforge.io/Main_Page). This requires that you have NSIS installed on your machine.
+
+The generated binary will live in `build/bin`. You may want to run the installer (Windows) or move the app to the Applications folder (Mac).

docs/user-guide.md

@@ -0,0 +1,7 @@
+---
+title: User guide
+summary: Rolens is designed to be as intuitive as possible. But if something is unclear nevertheless, you can read this manual to learn how to use the program.
+order: 30
+---
+
+{{ collections.all | eleventyNavigation: "User guide" | eleventyNavigationToMarkdown }}

docs/user-guide/collections.md

@@ -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 %}

docs/user-guide/collections/aggregation.md

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

docs/user-guide/collections/find.md

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

docs/user-guide/collections/indexes.md

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

docs/user-guide/collections/insert.md

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

docs/user-guide/collections/remove.md

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

docs/user-guide/collections/stats.md

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

docs/user-guide/collections/update.md

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

docs/user-guide/databases.md

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

docs/user-guide/hosts.md

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

docs/user-guide/logfiles.md

@@ -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.

docs/user-guide/preferences.md

@@ -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.