Add more docs and refine website further

Author: jonnydgreen

.gitattributes

@@ -2,6 +2,8 @@
 * text=auto eol=lf
 
 # Only include the addons/parley folder when downloading from the Asset Library.
-/**        export-ignore
-/addons/parley    !export-ignore
+** export-ignore
+/addons !export-ignore
+/addons/* export-ignore
+/addons/parley !export-ignore
 /addons/parley/** !export-ignore

README.md

@@ -2,20 +2,20 @@
 
 Parley is an addon for [Godot 4.4+](https://godotengine.org/) that provides a
 graph-based dialogue manager for easy writing, testing, and running of dialogue
-sequences at scale. Write your dialogue sequences by defining the graph for your
-dialogue sequence which are backed by a well-defined Dialogue AST for easy
-management and integration within your game.
+sequences at scale and is designed to be used by game writers and developers
+alike.
 
-<!-- TODO: check the link -->
-<!-- TODO: credits and licensing -->
+Write your dialogue sequences by defining the graph for your dialogue sequence
+which are backed by a well-defined Dialogue AST for easy management and
+integration within your game.
 
 You can install it via the Asset Library or
 [downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
 from GitHub.
 
 [![GitHub Licence](https://img.shields.io/github/license/bisterix-studio/parley?style=flat-square)](https://raw.githubusercontent.com/bisterix-studio/parley/main/LICENSE)
 
-![Example usage of Parley](docs/img/parley.png)
+![Example usage of Parley](https://parley.bisterixstudio.com/illustration/parley-graph-view.gif)
 
 ## Table of contents
 
@@ -34,15 +34,15 @@ Installation Features Examples Support Useful links Licence Contributions
 ## Features
 
 - An easy to use and well-defined Graph Editor
-- A wide variety of nodes for maximum flexibility:
-  - [Dialogue](docs/nodes/dialogue_node.md)
-  - [Dialogue Option](docs/nodes/dialogue_option_node.md)
-  - [Condition](docs/nodes/condition_node.md)
-  - [Match](docs/nodes/match_node.md)
-  - [Action](docs/nodes/action_node.md)
-  - [Group](docs/nodes/group_node.md)
-  - [Start](docs/nodes/start_node.md)
-  - [End](docs/nodes/end_node.md)
+- A wide variety of nodes for maximum flexibility and creativity:
+  - [Dialogue](https://parley.bisterixstudio.com/docs/nodes/dialogue-node)
+  - [Dialogue Option](https://parley.bisterixstudio.com/docs/nodes/dialogue-option-node)
+  - [Condition](https://parley.bisterixstudio.com/docs/nodes/condition-node)
+  - [Match](https://parley.bisterixstudio.com/docs/nodes/match-node)
+  - [Action](https://parley.bisterixstudio.com/docs/nodes/action-node)
+  - [Group](https://parley.bisterixstudio.com/docs/nodes/group-node)
+  - [Start](https://parley.bisterixstudio.com/docs/nodes/start-node)
+  - [End](https://parley.bisterixstudio.com/docs/nodes/end-node)
 - Creation of connections between nodes to easily see the flow of your dialogue
   sequence
 - Easy testing of your dialogue at any stage in the sequence
@@ -52,19 +52,22 @@ Installation Features Examples Support Useful links Licence Contributions
 - Fact store for management of facts for use with Condition and Match nodes
 - An out of the box dialogue balloon to get started straight away
 - Easy management of your dialogue sequences, including node filtering
-- Export of Dialogue passages
+- Export your Dialogue passages to CSV
 
 ## Installation
 
-<!-- TODO: check the link -->
-
 You can install it via the Asset Library or
 [downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
 from GitHub.
 
+Once installed, please following the guide for first-time setup.
+
+[Installation Guide](https://parley.bisterixstudio.com/docs/getting-started/installation)
+
 ## Documentation
 
-Documentation for Parley can be found [here](docs/parley.md).
+Documentation for Parley can be found
+[here](https://parley.bisterixstudio.com/docs).
 
 ## Support
 
@@ -83,12 +86,13 @@ submit an issue if you have any further data on this issue.
 ## Licence
 
 Parley is 100% free and open-source, under the MIT licence.
+[The license is distributed with Parley and can be found in the `addons/parley` folder](https://github.com/bisterix-studio/parley/blob/main/addons/parley/LICENSE).
 
 ## Contributions
 
-[Contributions](./CONTRIBUTING.md), issues and feature requests are very
-welcome. If you are using this package and fixed a bug for yourself, please
-consider submitting a PR!
+[Contributions](https://github.com/bisterix-studio/parley/blob/main/CONTRIBUTING.md),
+issues and feature requests are very welcome. If you are using this package and
+fixed a bug for yourself, please consider submitting a PR!
 
 <p align="center">
   <a href="https://github.com/bisterix-studio/parley/graphs/contributors">

addons/parley/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bisterix Studio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

addons/parley/README.md

@@ -0,0 +1,101 @@
+# Parley
+
+Parley is an addon for [Godot 4.4+](https://godotengine.org/) that provides a
+graph-based dialogue manager for easy writing, testing, and running of dialogue
+sequences at scale and is designed to be used by game writers and developers
+alike.
+
+Write your dialogue sequences by defining the graph for your dialogue sequence
+which are backed by a well-defined Dialogue AST for easy management and
+integration within your game.
+
+You can install it via the Asset Library or
+[downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
+from GitHub.
+
+[![GitHub Licence](https://img.shields.io/github/license/bisterix-studio/parley?style=flat-square)](https://raw.githubusercontent.com/bisterix-studio/parley/main/LICENSE)
+
+![Example usage of Parley](https://parley.bisterixstudio.com/illustration/parley-graph-view.gif)
+
+## Table of contents
+
+- [Table of contents](#table-of-contents)
+- [Features](#features)
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [Support](#support)
+- [Known Issues and Troubleshooting](#known-issues-and-troubleshooting)
+  - [Parts of Godot are unresponsive in MacOS after close a test dialogue scene via the close button](#parts-of-godot-are-unresponsive-in-macos-after-close-a-test-dialogue-scene-via-the-close-button)
+- [Licence](#licence)
+- [Contributions](#contributions)
+
+Installation Features Examples Support Useful links Licence Contributions
+
+## Features
+
+- An easy to use and well-defined Graph Editor
+- A wide variety of nodes for maximum flexibility and creativity:
+  - [Dialogue](https://parley.bisterixstudio.com/docs/nodes/dialogue-node)
+  - [Dialogue Option](https://parley.bisterixstudio.com/docs/nodes/dialogue-option-node)
+  - [Condition](https://parley.bisterixstudio.com/docs/nodes/condition-node)
+  - [Match](https://parley.bisterixstudio.com/docs/nodes/match-node)
+  - [Action](https://parley.bisterixstudio.com/docs/nodes/action-node)
+  - [Group](https://parley.bisterixstudio.com/docs/nodes/group-node)
+  - [Start](https://parley.bisterixstudio.com/docs/nodes/start-node)
+  - [End](https://parley.bisterixstudio.com/docs/nodes/end-node)
+- Creation of connections between nodes to easily see the flow of your dialogue
+  sequence
+- Easy testing of your dialogue at any stage in the sequence
+- Well-defined Dialogue AST for easy review and management of Dialogue Sequences
+- Character store for management of characters in Dialogue and Dialogue Options
+- Action store for management of actions for use with Action nodes
+- Fact store for management of facts for use with Condition and Match nodes
+- An out of the box dialogue balloon to get started straight away
+- Easy management of your dialogue sequences, including node filtering
+- Export your Dialogue passages to CSV
+
+## Installation
+
+You can install it via the Asset Library or
+[downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
+from GitHub.
+
+Once installed, please following the guide for first-time setup.
+
+[Installation Guide](https://parley.bisterixstudio.com/docs/getting-started/installation)
+
+## Documentation
+
+Documentation for Parley can be found
+[here](https://parley.bisterixstudio.com/docs).
+
+## Support
+
+| Version  | Supported	Godot version |
+| -------- | ----------------------- |
+| `latest` | `4.4+`                  |
+
+## Known Issues and Troubleshooting
+
+### Parts of Godot are unresponsive in MacOS after close a test dialogue scene via the close button
+
+**Solution:** Swipe up with three fingers to open Mission Control. Swipe down
+again to make Godot responsive again. Currently not sure why it happens, please
+submit an issue if you have any further data on this issue.
+
+## Licence
+
+Parley is 100% free and open-source, under the MIT licence.
+[The license is distributed with Parley and can be found in the `addons/parley` folder](https://github.com/bisterix-studio/parley/blob/main/addons/parley/LICENSE).
+
+## Contributions
+
+[Contributions](https://github.com/bisterix-studio/parley/blob/main/CONTRIBUTING.md),
+issues and feature requests are very welcome. If you are using this package and
+fixed a bug for yourself, please consider submitting a PR!
+
+<p align="center">
+  <a href="https://github.com/bisterix-studio/parley/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=bisterix-studio/parley&columns=8" />
+  </a>
+</p>

docs/latest/concepts/architecture.md

@@ -0,0 +1,43 @@
+---
+description: |
+  Parley uses a graph-based architecture for its dialogue sequences. A Graph-based
+  Architecture revolves around the concepts of nodes and edges. Here, nodes are the atomic
+  building blocks of a graph and are linked together by
+  edges.
+---
+
+Parley uses a graph-based architecture for its dialogue sequences. A Graph-based
+Architecture revolves around the concepts of nodes and edges. Here, nodes are
+the atomic building blocks of the graph and are linked together by edges.
+
+## Dialogue Sequence
+
+In Parley, a Dialogue Sequence is a graph. These are built up of Nodes (for
+example, a dialogue node and associated dialogue options). These are connected
+together by edges to create the branching dialogue from start to finish.
+
+Parley utilises what is known as a directed-graph. This means that edges have a
+direction, which is critical for defining how a dialogue sequence progresses.
+
+The advantage of a graph-based architecture allows Parley to be highly-flexible
+in how dialogues can be defined and at its core, gives the users to ability to
+create highly complex branching dialogues (including loops and multiple paths)
+whilst keeping it easy to maintain with a visual representation of the dialogue
+that is strongly-tied to the underlying data structure.
+
+## Node
+
+The atomic building block of a Dialogue Sequence. Every piece of functionality
+in Parley is at its core a node. These can be defined and combined countless
+times within a dialogue sequence to create highly intricate behaviours and
+gameplay. The sky is the limit for how these can be combined!
+
+## Edge
+
+A connection between two nodes. They have a direction defined by two attributes:
+
+- "from node"
+- "to node"
+
+These tell Parley what the next node(s) will be after processing the current
+node.

docs/latest/getting-started/index.md

@@ -9,6 +9,4 @@ deploy to your game.
 
 The documentation assumes you have the latest version of
 [Godot](https://godotengine.org/) installed on your system and have also
-installed the Parley plugin.
-
-<!-- TODO: add installation page -->
+[installed the Parley plugin](./installation.md).

docs/latest/getting-started/installation.md

@@ -3,12 +3,88 @@ description: |
   Installation
 ---
 
-Installation: TODO
+You can download Parley directly or install it from the Asset Lib in the Godot
+Editor.
 
 ## Pre-requisites
 
 - [Godot 4.4+](https://godotengine.org/) is installed.
 
 ## Instructions
 
-TODO
+### Installing from the Godot Asset Lib within the editor
+
+1. Select the AssetLib button at the top of the Godot editor.
+2. Search for `Parley` in the search box
+3. Select the Parley plugin.
+4. Click `Install`. This will kick off the download.
+5. Voila!
+
+Complete the first time installation by following the
+[instructions](#first-time-installation) below.
+
+## Download and install
+
+<!-- TODO: correct the link -->
+
+Download the compressed zip file from the
+[Parley releases page on GitHub](https://github.com/bisterix-studio/parley/releases)
+or from the
+[Godot Asset Library](https://godotengine.org/asset-library/asset/TODO).
+
+Extract the compressed zip file and place the `parley` directory into your
+`addons` directory in your project.
+
+Complete the first time installation by following the
+[instructions](#first-time-installation) below.
+
+### First-time installation
+
+When you install Parley for the first time, the following stores will need to be
+set-up, otherwise you will receive some warnings in the editor:
+
+- Action store
+- Fact store
+- Character store
+
+To resolve these warnings, create the following resources in the Godot editor
+and for each, fill out the fields as appropriate.
+
+> [warn]: You don't need to add items to them at this point, you will be able to
+> do this via the respective store editor.
+
+| Resource               | Store           |
+| ---------------------- | --------------- |
+| `ParleyFactStore`      | Fact Store      |
+| `ParleyActionStore`    | Action Store    |
+| `ParleyCharacterStore` | Character Store |
+
+Then, from the menu choose Project -> Project Settings, search for `Parley` in
+the settings and set the following settings with the files you created above:
+
+- `Action Store Path`
+- `Fact Store Path`
+- `Character Store Path`
+
+Your settings should look like the following:
+
+![parley-store-paths](../../../www/static/docs/installation/parley-store-paths.png)
+
+### Activate
+
+1. From the menu choose Project->Project Settings, click the Plugins tab and
+   activate Gut. Once activated, the GUT Panel will appear at the bottom of your
+   editor:
+
+![Gut Panel Location](_static/images/gut_panel_where.png)
+
+### Setup directories for tests
+
+The next few steps cover the suggested configuration. Feel free to deviate where
+you see fit.
+
+1. Create directories to store your tests and test related code (suggested
+   config)
+   - `res://test`
+   - `res://test/unit`
+   - `res://test/integration`