Updated problems in Writerside documentation

SteveDunn · Jun 2, 2024 · 6d8954f · 6d8954f
1 parent 32c74db
commit 6d8954f
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 97 deletions.
diff --git a/docs/site/Writerside/hi.tree b/docs/site/Writerside/hi.tree
@@ -10,15 +10,14 @@
     </toc-element>
     <toc-element topic="Tutorials.topic">
         <toc-element topic="Installation.md"/>
-        <toc-element topic="your-first-value-object.md"/>
+        <toc-element topic="your-first-intellenum-enum.md"/>
         <toc-element topic="Serialization.md"/>
         <toc-element topic="Using-with-JSON.md"/>
         <toc-element topic="Working-with-logging-frameworks.md"/>
         <toc-element topic="Working-with-databases.md"/>
     </toc-element>
     <toc-element topic="how-to-guides.topic">
-        <toc-element topic="create-and-use-value-objects.md"/>
-        <toc-element topic="Instances.md"/>
+        <toc-element topic="create-and-use-intellenum-enums.md"/>
         <toc-element topic="Integration.md"/>
         <toc-element topic="customize-string-comparisons.md"/>
         <toc-element topic="Casting.md"/>

diff --git a/docs/site/Writerside/redirection-rules.xml b/docs/site/Writerside/redirection-rules.xml
@@ -82,4 +82,8 @@
         <description>Created after removal of "Records" from Intellenum</description>
         <accepts>Records.html</accepts>
     </rule>
+    <rule id="3e1cff78">
+        <description>Created after removal of "Specify pre-set Instances" from Intellenum</description>
+        <accepts>Instances.html</accepts>
+    </rule>
 </rules>
diff --git a/docs/site/Writerside/topics/Intellenum.topic b/docs/site/Writerside/topics/Intellenum.topic
@@ -16,7 +16,7 @@
         <spotlight>
             <a href="Overview.md"
                description="Overview" type="learn" summary="Discover what Intellenum is"/>
-            <a href="your-first-value-object.md"
+            <a href="your-first-intellenum-enum.md"
                description="Get started" type="development" summary="Get started"/>
         </spotlight>
 

diff --git a/docs/site/Writerside/topics/Tutorials.topic b/docs/site/Writerside/topics/Tutorials.topic
@@ -25,15 +25,15 @@
 
         <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
         <spotlight>
-            <a href="Installation.md" type="install" summary="Installing Vogen into your project"/>
-            <a href="your-first-value-object.md" type="development" summary="Write and use your first Value Object">Create your first Value Object</a>
+            <a href="Installation.md" type="install" summary="Installing Intellenum into your project"/>
+            <a href="your-first-intellenum-enum.md" type="development" summary="Write and use your first Intellenum enum">Create your first Intellenum enum</a>
         </spotlight>
 
         <!--    Add several topics that are most important for this section.    -->
         <primary>
             <title>Going further...</title>
-            <a href="ValidationTutorial.md" type="cross-check" summary="Validating the data used to create Value Objects"/>
-            <a href="NormalizationHowTo.md" type="documents" summary="Normalize (sanitize) the data in your Value Objects"/>
+            <a href="Working-with-databases.md" type="cross-check" summary="Validating the data used to create Value Objects"/>
+            <a href="Serialization.md" type="documents" summary="Normalize (sanitize) the data in your Value Objects"/>
         </primary>
 
         <!--    Add several topics that are less important or are relevant only for advanced/experienced users.    -->

diff --git a/docs/site/Writerside/topics/how-to-guides.topic b/docs/site/Writerside/topics/how-to-guides.topic
@@ -23,8 +23,8 @@
 
         <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
         <spotlight>
-            <a href="create-and-use-value-objects.md" type="account"/>
-            <a href="Instances.md" type="search" summary="Create known instances with specific up-front values">Up-front values</a>
+            <a href="create-and-use-intellenum-enums.md" type="account"/>
+            <a href="Serialization.md" type="search" summary="Serialize to and from various formats">Serialization</a>
         </spotlight>
 
         <!--    Add several topics that are most important for this section.    -->
@@ -38,7 +38,6 @@
         <secondary>
             <title>Exploring more advanced features</title>
             <a href="EfCoreIntegrationHowTo.md"/>
-            <a href="NormalizationHowTo.md" summary="How to normalize (sanitize) input values"/>
         </secondary>
     </section-starting-page>
 

diff --git a/docs/site/Writerside/topics/how-to/Testing.md b/docs/site/Writerside/topics/how-to/Testing.md
@@ -30,7 +30,6 @@ The snapshot tests in the IDE run in about 5 minutes. In the CI build, we set a
   These tests are much quicker to run.
   They verify the behavior
  of created Value Objects, such as:
-    * [Normalization](NormalizationHowTo.md "How to use normalization")
     * Equality
     * Hashing
     * ToString

diff --git a/...cs/how-to/create-and-use-value-objects.md → ...how-to/create-and-use-intellenum-enums.md b/...cs/how-to/create-and-use-value-objects.md → ...how-to/create-and-use-intellenum-enums.md
diff --git a/docs/site/Writerside/topics/tutorials/Instances.md b/docs/site/Writerside/topics/tutorials/Instances.md
diff --git a/docs/site/Writerside/topics/tutorials/Serialization.md b/docs/site/Writerside/topics/tutorials/Serialization.md
@@ -1,5 +1,12 @@
 # Working with ASP.NET Core
 
+<note>
+This topic is copied from Vogen and/or is incomplete. It is being worked on (or is planned
+to be worked on). 
+
+If you would like to help with this, please see the list of [open issues](https://github.com/SteveDunn/Intellenum/issues).
+</note>
+
 In this tutorial, we'll create a value object and use it an ASP.NET Core Web API project.
 
 We'll see how the .NET Runtime uses 'Type Converters' to convert from primitives that are provided

diff --git a/docs/site/Writerside/topics/tutorials/Working-with-databases.md b/docs/site/Writerside/topics/tutorials/Working-with-databases.md
@@ -4,7 +4,7 @@
 This topic is incomplete and is being improved.
 </note>
 
-Vogen has converters and serializers for databases, including:
+Intellenum has converters and serializers for databases, including:
 
 * Dapper
 * EFCore