docs: big docs update, closes #4

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: '🐛 Bug Report'
+about: Report a bug
+title: 'Bug: '
+---
+
+<!--
+Which docker container tag are you using?
+e.g. `latest`, `main`, `2.1.3`, `2.1`
+
+If you are using `latest` or `main` please ensure you are using the most recent version.
+-->
+
+Docker Container Version:
+
+## Steps To Reproduce
+
+1.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,9 @@
+---
+name: '✨ Feature Request'
+about: Request a new feature.
+title: 'Feature Request: '
+---
+
+<!--
+Explain your feature request here.
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+## Checklist
+
+- [ ] Documentation updated
+
+## Summary
+
+<!-- Explain your changes here -->

README.md

@@ -20,3 +20,12 @@ The next version of Net-Doc is aiming to be `1.1`, these are the
 The longer term goals are listed in the
 [version next](https://github.com/Longridge-High-School/net-doc/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22Version+Next%22)
 milestone.
+
+## Technology
+
+Net-Doc incorperates quite a few open source technologies, some of which are
+listed here:
+
+- Remix
+- Prisma
+- React

docs/_data/callout_features.yml

@@ -22,3 +22,8 @@ items:
     icon: fa-user-shield
     description: >
       Build your own Access Control Lists and assign them to Assets and Entries.
+  - title: Processes
+    subtitle: Build out your standard processes.
+    icon: fa-gears
+    description: >
+      Build standard and repeatable processes from your documents.

docs/_data/docs_menu.yml

@@ -8,12 +8,16 @@
   items:
     - name: Assets
       link: /docs/concepts/assets
+    - name: Documents
+      link: /docs/concepts/documents
     - name: Entries
       link: /docs/concepts/entries
     - name: Fields
       link: /docs/concepts/fields
     - name: Passwords
       link: /docs/concepts/passwords
+    - name: Processes
+      link: /docs/concepts/processes
 - label: Fields
   items:
     - name: Attachment
@@ -34,3 +38,11 @@
   items:
     - name: Approaching Dates
       link: /docs/dashboard-boxes/approaching-dates
+    - name: Pinned Items
+      link: /docs/dashboard-boxes/pinned-items
+    - name: Recent Changes
+      link: /docs/dashboard-boxes/recent-changes
+    - name: Recent Documents
+      link: /docs/dashboard-boxes/recent-documents
+    - name: Stats
+      link: /docs/dashboard-boxes/stats

docs/docs/concepts/documents.md

@@ -0,0 +1,15 @@
+---
+title: Documents
+---
+
+Net-Doc has a document store that can be used to store any markdown document.
+
+When linking to an [entry](/net-doc/docs/concepts/entries) the document will
+appear as a _Linked Document_ in the sidebar of the entry.
+
+If a document contains a checkbox as below you will be able to start it as a
+[process](/net-doc/docs/concepts/processes).
+
+```md
+- [ ] Checkbox
+```

docs/docs/concepts/processes.md

@@ -0,0 +1,12 @@
+---
+title: Processes
+---
+
+Any [document](/net-doc/docs/concepts/documents) that contains a checkbox
+`- [ ]` can be started as a process. Simply open the document and click _Run
+Process_.
+
+A process can be edited like any document.
+
+Any checkbox can be checked interactively on the process display, this is then
+saved in the markdown.

docs/docs/dashboard-boxes/pinned-items.md

@@ -0,0 +1,9 @@
+---
+title: Pinned Items
+---
+
+The pinned items dashboard box displays a list of the users pinned items.
+
+## Configuration
+
+_Pinned Items has no configuration_.

docs/docs/dashboard-boxes/recent-changes.md

@@ -0,0 +1,10 @@
+---
+title: Recent Changes
+---
+
+The recent changes dashboard box displays a list of the 5 most recently edited
+entries across all assets.
+
+## Configuration
+
+_Recent Changes has no configuration_.

docs/docs/dashboard-boxes/recent-documents.md

@@ -0,0 +1,10 @@
+---
+title: Recent Documents
+---
+
+The recent documents dashboard box displays a list of the 5 most recently edited
+documents.
+
+## Configuration
+
+_Recent Documents has no configuration_.

docs/docs/dashboard-boxes/stats.md

@@ -0,0 +1,10 @@
+---
+title: Stats
+---
+
+The stats dashboard box displays a few statistics from Net-Doc, number of
+values, entries, assets etc...
+
+## Configuration
+
+_Stats has no configuration_.

docs/docs/getting-started/initial-setup.md

@@ -82,8 +82,85 @@ This asset will need some more fields.
 
 | Name             | Description                                   |   Type   | Asset Relation | Options                                      |
 | :--------------- | :-------------------------------------------- | :------: | :------------- | :------------------------------------------- |
-| Hostname         | Hostname field for any device on the network. |   text   |                |                                              |
+| Device Name      | Hostname field for any device on the network. |   text   |                |                                              |
 | Asset            | Relation to Asset Register                    | relation | Asset Register |                                              |
 | Operating System | A select field for operating systems          |  select  |                | Windows 10, Windows 11 (Each on a new line). |
 
-As with the asset register create a new asset using these feilds.
+As with the asset register create a new asset using these feilds and these
+settings:
+
+|          |                  |
+| :------- | :--------------- |
+| Name     | Windows Computer |
+| Slug     | windows-computer |
+| Singular | Computer         |
+| Plural   | Computers        |
+| ACL      | Default          |
+
+| Field            | Helper Text                               | Order | Display on Table |
+| :--------------- | :---------------------------------------- | :---: | :--------------: |
+| Device Name      | The computers hostname                    |   1   |       `no`       |
+| Asset            | The Asset Register tag for this computer. |   2   |       `no`       |
+| Operating System | The operating system on the computer      |   3   |       `no`       |
+
+Edit the asset once you have added all the fields with these settings:
+
+|            |             |
+| :--------- | :---------- |
+| Icon       | 🖥️          |
+| Name Field | Device Name |
+| Sort Field | Device Name |
+
+### ChromeOS Device
+
+As with Windows Computers we need to create a new asset, but this time we
+already have all the fields we need. The only change needed is to edit the
+`Operating System` field to have `ChromeOS` as an additional option.
+
+Follow the same procedure as the Windows Computers to create teh asset with
+these settings:
+
+|          |                  |
+| :------- | :--------------- |
+| Name     | ChromeOS Device  |
+| Slug     | chromeos-device  |
+| Singular | ChromeOS Device  |
+| Plural   | ChromeOS Devices |
+| ACL      | Default          |
+
+| Field            | Helper Text                                 | Order | Display on Table |
+| :--------------- | :------------------------------------------ | :---: | :--------------: |
+| Device Name      | The chromebooks hostname                    |   1   |       `no`       |
+| Asset            | The Asset Register tag for this chromebook. |   2   |       `no`       |
+| Operating System | The OS of the Chromebook.                   |   3   |       `no`       |
+
+Edit the asset once you have added all the fields with these settings:
+
+|            |             |
+| :--------- | :---------- |
+| Icon       | 💻          |
+| Name Field | Device Name |
+| Sort Field | Device Name |
+
+## Adding Data
+
+Its now possible to add data to Net-Doc!
+
+Lets say there is a Windows Computer on the network called `Desktop-456`. It's a
+`HP EliteDesk 800 G4`, serial number `CND123456`, Asset Tag `ND00123`, in the
+`Main Office`, and running `Windows 11`.
+
+From the sidebar select the newly created _Asset Register_ and hit _Add Asset_
+at the top right.
+
+The new Asset needs the _Asset Tag_ `ND00123`, the _Make/Model_ of
+`HP EliteDesk 800 G4`, _serial number_ of `CND123456` and the _location_ of
+`Main Office`.
+
+Now head to the _Windows Computer_ asset and hit _Add Asset_ again.
+
+This time the _device name_ is `Desktop-456` and the _operating system_ is
+`Windows 11`. In the _Asset_ field search for the Asset tag `ND00132`. Setting
+this will link the two assets. The Windows Computer will have an value in its
+entry that links to the Asset Register Entry. The Asset Register will have a
+linked asset in sidebar to the Windows Computer.

docs/docs/getting-started/install.md

@@ -57,3 +57,27 @@ services:
 | `/app/prisma/data`    | Contains the sqlite database                              |
 | `/app/public/uploads` | [Attachments](/docs/fields/attachment) are uploaded here. |
 | `/app/public/backups` | Contains the generated backup files                       |
+
+## Launching
+
+With the `docker-compose.yml` in a folder with the paths updated you can then
+pull the images.
+
+```sh
+docker compose pull
+```
+
+Once the images are pulled you can launch net-doc by running:
+
+```sh
+docker compose up -d
+```
+
+This will create a new docker container running the Net-Doc image, and the redis
+image.
+
+Every time Net-Doc starts up it runs all the
+[prisma migrations](https://github.com/Longridge-High-School/net-doc/tree/main/prisma/migrations)
+to intially create the database and keep it in sync. The same process also runs
+the seed command which will update any data in the database to match the new
+schema.