Add known issuse, upgrade guide

Author: András Kurai

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Configure using directives
 - Remove `IsResource` property from `IResourceData`. Scene path generation now depends on file extension
 - Handle spaces in filenames
+- Add known issues and update guide in the documentation
 
 # 0.1.0
 - Add initial project

Documentation/articles/KnownIssues.md

@@ -0,0 +1,16 @@
+# Known issues
+
+## 0.1.0 - *
+
+- SpecialCharacters can break generated names.
+  - Numbers at the end of the files are supported, but not at the start
+  - Any character in the filename which would not be a valid C# filed/property/method name will break the generated code
+  - Spaces get removed
+  - For Example:
+    - `Coin1` works
+    - `Coin 1` works
+    - `1Coin` does not
+    - `!Coin` does not
+    - `Coin!` does not
+
+- Duplicate file names in the same class module will break the generated file. The solution for this requires further investigation

Documentation/articles/UpgradeGuide.md

@@ -0,0 +1,6 @@
+# Upgrade Guide
+
+Always update using the Unity Package Manager
+
+## 0.1.0 - *
+- If default file mappings or namespaces change, and you have custom ones, it is advised that you create a copy of your old settings, press the `Reset file mappings` button in the `Project Settings` window and then manually recreate your custom mappings.

Documentation/articles/toc.yml

@@ -4,3 +4,7 @@
   href: Customization.md
 - name: Extensibility
   href: Extensibility.md
+- name: Known Issues
+  href: KnownIssues.md
+- name: Upgrade Guide
+  href: UpgradeGuide.md