More docs

SteveDunn · Dec 11, 2023 · 2475ab6 · 2475ab6
1 parent a09579e
commit 2475ab6
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 4 deletions.
diff --git a/docs/site/Writerside/topics/Configuration.md b/docs/site/Writerside/topics/Configuration.md
@@ -1,5 +1,10 @@
 # Configuration
 
+<note>
+This topic is incomplete and is currently being improved.
+</note>
+
+
 Each Value Object can have its own *optional* configuration. Configuration includes:
 
 * The underlying type

diff --git a/docs/site/Writerside/topics/Performance.md b/docs/site/Writerside/topics/Performance.md
@@ -1,5 +1,10 @@
 # Performance
 
+<note>
+This topic is incomplete and is currently being improved.
+</note>
+
+
 (to run these yourself: `dotnet run -c Release --framework net7.0 -- --job short --filter *` in the `Vogen.Benchmarks` folder)
 
 As mentioned previously, the goal of Vogen is to achieve very similar performance compared to using primitives themselves.

diff --git a/docs/site/Writerside/topics/discussions/Terms-Used.md b/docs/site/Writerside/topics/discussions/Terms-Used.md
@@ -1,3 +1,5 @@
 # Terms Used
 
-Start typing here...
+<note>
+This topic is incomplete and is currently being improved.
+</note>
diff --git a/...e/Writerside/topics/how-to/How-to-identify-a-type-that-is-generated-by-Vogen.md b/...e/Writerside/topics/how-to/How-to-identify-a-type-that-is-generated-by-Vogen.md
@@ -1,3 +1,8 @@
+<note>
+This topic is incomplete and is currently being improved.
+</note>
+
+
 # Identifying types that are generated by Vogen
 The goal of this is to identify types that are generated by Vogen.
 

diff --git a/docs/site/Writerside/topics/reference/FAQ.md b/docs/site/Writerside/topics/reference/FAQ.md
@@ -1,5 +1,10 @@
 # FAQ
 
+<note>
+This topic is incomplete and is currently being improved.
+</note>
+
+
 ## What tests are there
 There are unit tests for Vogen itself, and there are snapshot tests to test that the source code that is generated
 matches what is expected.

diff --git a/docs/site/Writerside/topics/reference/Records.md b/docs/site/Writerside/topics/reference/Records.md
@@ -1,5 +1,10 @@
 # Records
 
+<note>
+This topic is incomplete and is currently being improved.
+</note>
+
+
 Vogen supports records (`record class` and `record struct`). 
 
 > **NOTE**: It is recommended to use a vanilla `class` or `struct` over records. The benefits of records don't really 

diff --git a/docs/site/Writerside/topics/reference/Reference.md b/docs/site/Writerside/topics/reference/Reference.md
@@ -2,7 +2,8 @@
 
 Here you can find information on the types used when using Vogen.
 
+<note>
+This topic is incomplete and is currently being improved.
+</note>
 
 
-## VogenConfiguration
-
diff --git a/docs/site/Writerside/topics/reference/Types.md b/docs/site/Writerside/topics/reference/Types.md
@@ -1,3 +1,5 @@
 # Types
 
-Start typing here...
+<note>
+This topic is incomplete and is currently being improved.
+</note>