Updates related to documentation

Author: sgiffinlcd

docs/guidance/Introduction/Overview.html

@@ -102,7 +102,7 @@ <h3 id="user-interfaces">User Interfaces</h3>
 <p><a href="UI/Overview.html">CodeFactory User Interface</a></p>
 <h2 id="codefactory-guidance">CodeFactory Guidance</h2>
 <p>A variety of &quot;walk-through&quot; scenario-driven guidance is provided to help you get started and understand how to use the CodeFactory SDK.</p>
-<p><a href="../Guidance/Overview.md">CodeFactory Guidance</a></p>
+<p><a href="../howto/Overview.html">CodeFactory Guidance</a></p>
 </article>
           </div>
 

docs/guidance/howto/CreateProject/CreateProject.html

@@ -82,74 +82,74 @@ <h1 id="creating-a-project">Creating a Project</h1>
 
 <p>The first step will be to create a project and register our first command.</p>
 <h2 id="background">Background</h2>
-<p>The following is important background information on CodeFatory itself.
+<p>The following is important background information on CodeFactory itself.
 This will help you understand the default startup behavior the first time you create a CodeFactory project.</p>
-<h3 id="nuget">Nuget</h3>
-<p>CodeFactory was designed to load the target versions of the SDK libraries directly from Nuget.
-The way that this is accomplished is by adding direct project references to the target version hosted on nuget.
-With the legacy project system used to host .Net framework it does not automatically pull down these nuget packages when you load the project for the first time.
+<h3 id="nuget">NuGet</h3>
+<p>CodeFactory was designed to load the target versions of the SDK libraries directly from NuGet.
+The way that this is accomplished is by adding direct project references to the target version hosted on NuGet.
+With the legacy project system used to host .Net framework it does not automatically pull down these NuGet packages when you load the project for the first time.
 So if any CodeFactory project items are added you will get a number of errors related to the libraries not being loaded.
-The Nuget packages will automatically be pulled down the first time you do a build of the project itself, these errors will then go away.</p>
+The NuGet packages will automatically be pulled down the first time you do a build (Ctrl-Shift-B) of the project itself, these errors will then go away.</p>
 <h3 id="codefactory-packager">CodeFactory Packager</h3>
 <p>A CodeFactory commands project is the main execution point for all CodeFactory automation.
 This project will automatically execute a command line utility after the compile of the project has completed.
-The CFXPackager utility is responsible for building the CFX file that is used to run codefactory automation.</p>
+The CFXPackager utility is responsible for building the CFX file that is used to run CodeFactory automation.</p>
 <p>If no commands are defined in the project this utiltity will output a error saying the package could not be built.
 This error will go away once the first command is added to the project.</p>
-<h2 id="walk-through-steps">Walk through Steps</h2>
-<p>The following is the walk through for creating the project and make sure you can successfully compile the code factory project.</p>
+<h2 id="walk-through-steps">Walk-through Steps</h2>
+<p>Follow these steps to successfully create and compile your CodeFactory project:</p>
 <ol>
 <li>Start Visual Studio 2019</li>
 </ol>
 <hr>
 <ol start="2">
-<li>From the What would you like to do? window click Create a new project
+<li>From the &quot;What would you like to do?&quot; window click &quot;Create a new project&quot;.
 <img src="Images/StartWindowCreateProject.png" alt=""></li>
 </ol>
 <p>Or you can start the same process if you dont use the start up window.</p>
 <ul>
 <li>Click the File menu</li>
 <li>From the context menu select New</li>
-<li>From the sub context menu select Project</li>
+<li>From the sub-context menu select Project</li>
 </ul>
 <p><img src="Images/FileNewProject.png" alt=""></p>
 <hr>
 <ol start="3">
-<li>From the Create a new project window do the following</li>
+<li>From the &quot;Create a new project&quot; window do the following:</li>
 </ol>
 <p><img src="Images/SelectCommandLibraryProject.png" alt=""></p>
 <ul>
 <li>In the search box type CodeFactory</li>
-<li>From The list of projects select CodeFactory - Commands Library</li>
-<li>Click Next</li>
+<li>From The list of projects select &quot;CodeFactory - Commands Library&quot;</li>
+<li>Click &quot;Next&quot;</li>
 </ul>
 <hr>
 <ol start="4">
-<li>From the Configure you new project do the following</li>
+<li>From the &quot;Configure your new project&quot; window do the following:</li>
 </ol>
 <p><img src="Images/ConfigureProject.png" alt=""></p>
 <ul>
-<li>In the project name box type DisplayProjectCommands</li>
+<li>In the &quot;project name&quot; box type &quot;DisplayProjectCommands&quot;</li>
 <li>Click Create</li>
 </ul>
 <hr>
 <ol start="5">
-<li>Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the sub folders.</li>
+<li>Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the sub-folders.</li>
 </ol>
 <p>The following is a brief overview of the goal for each folder.
-Important note each explorer command has its own folder.
+Important note: each Explorer Command has its own folder.
 The following structure is prescriptive only.
 You can create any folder structure you wish for your automation.</p>
 <p><img src="Images/ProjectFolderStructure.png" alt=""></p>
 <ul>
 <li>The Project folder is where project commands are created and stored</li>
 <li>The Dialog folder is for placement of user interface dialogs you created.</li>
 <li>The Logic folder is where you add logic that can be reused across multiple project commands</li>
-<li>The Template folder is where you add T4 template that as used by project commands.</li>
+<li>The Template folder is where you add T4 template that are used by project commands.</li>
 </ul>
 <hr>
 <ol start="6">
-<li>Next we will add a solution explorer project command to the project. Do the following steps.</li>
+<li>Next we will add a solution explorer project command to the project. Do the following steps:</li>
 </ol>
 <p><img src="Images/SolutionExplorerProjectNewItemAdd.png" alt=""></p>
 <ul>
@@ -159,7 +159,7 @@ <h2 id="walk-through-steps">Walk through Steps</h2>
 </ul>
 <hr>
 <ol start="7">
-<li>From the Add New Item Dialog Window do the following.</li>
+<li>From the Add New Item Dialog Window do the following:</li>
 </ol>
 <p><img src="Images/AddProjectCommandDialog.png" alt=""></p>
 <ul>
@@ -173,16 +173,16 @@ <h2 id="walk-through-steps">Walk through Steps</h2>
 <li>A Microsoft Visual Studio error box will appear.</li>
 </ol>
 <p><img src="Images/VisualStudioErrorDialogCodeFactory.png" alt=""></p>
-<p>This error occurs because the CodeFactory SDK nuget packages have not been downloaded into the project yet.
-Click Ok to continue.</p>
+<p>This error occurs because the CodeFactory SDK NuGet packages have not been downloaded into the project yet.
+This is normal. Click Ok to continue.</p>
 <hr>
 <ol start="9">
-<li>The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through nuget yet.</li>
+<li>The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through NuGet yet.</li>
 </ol>
 <p><img src="Images/CodeFactoryReferenceMissingError.png" alt=""></p>
 <hr>
 <ol start="10">
-<li>We will then build the solution this will trigger the pull of the nuget packages. Do the following.</li>
+<li>We will then Build the solution which will trigger the pull of the NuGet packages. Do the following:</li>
 </ol>
 <p><img src="Images/BuildSolution.png" alt=""></p>
 <ul>
@@ -191,7 +191,7 @@ <h2 id="walk-through-steps">Walk through Steps</h2>
 </ul>
 <hr>
 <ol start="11">
-<li>Once the build has completed it will have downloaded and installed the nuget packages into the project.</li>
+<li>Once the build has completed it will have downloaded and installed the NuGet packages into the project.</li>
 </ol>
 <p>You will now see the CodeFactorySDK reference in the project.</p>
 <p><img src="Images/CodeFactorySDKProjectReference.png" alt=""></p>

docs/index.json

@@ -1057,7 +1057,7 @@
   "guidance/howto/CreateProject/CreateProject.html": {
     "href": "guidance/howto/CreateProject/CreateProject.html",
     "title": "Creating a Project | CodeFactory Guidance",
-    "keywords": "Creating a Project The first step will be to create a project and register our first command. Background The following is important background information on CodeFatory itself. This will help you understand the default startup behavior the first time you create a CodeFactory project. Nuget CodeFactory was designed to load the target versions of the SDK libraries directly from Nuget. The way that this is accomplished is by adding direct project references to the target version hosted on nuget. With the legacy project system used to host .Net framework it does not automatically pull down these nuget packages when you load the project for the first time. So if any CodeFactory project items are added you will get a number of errors related to the libraries not being loaded. The Nuget packages will automatically be pulled down the first time you do a build of the project itself, these errors will then go away. CodeFactory Packager A CodeFactory commands project is the main execution point for all CodeFactory automation. This project will automatically execute a command line utility after the compile of the project has completed. The CFXPackager utility is responsible for building the CFX file that is used to run codefactory automation. If no commands are defined in the project this utiltity will output a error saying the package could not be built. This error will go away once the first command is added to the project. Walk through Steps The following is the walk through for creating the project and make sure you can successfully compile the code factory project. Start Visual Studio 2019 From the What would you like to do? window click Create a new project Or you can start the same process if you dont use the start up window. Click the File menu From the context menu select New From the sub context menu select Project From the Create a new project window do the following In the search box type CodeFactory From The list of projects select CodeFactory - Commands Library Click Next From the Configure you new project do the following In the project name box type DisplayProjectCommands Click Create Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the sub folders. The following is a brief overview of the goal for each folder. Important note each explorer command has its own folder. The following structure is prescriptive only. You can create any folder structure you wish for your automation. The Project folder is where project commands are created and stored The Dialog folder is for placement of user interface dialogs you created. The Logic folder is where you add logic that can be reused across multiple project commands The Template folder is where you add T4 template that as used by project commands. Next we will add a solution explorer project command to the project. Do the following steps. Right click on the project folder in solution explorer From the context menu select Add From the sub context menu select New Item... From the Add New Item Dialog Window do the following. From the Visual C# Items select CodeFactory Select Solution Explorer - Project Command In the name box enter ProjectInformationCommand.cs Then click Add A Microsoft Visual Studio error box will appear. This error occurs because the CodeFactory SDK nuget packages have not been downloaded into the project yet. Click Ok to continue. The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through nuget yet. We will then build the solution this will trigger the pull of the nuget packages. Do the following. From the top navigation bar click on Build From the context menu click Build Solution Once the build has completed it will have downloaded and installed the nuget packages into the project. You will now see the CodeFactorySDK reference in the project. You will also notice there are no longer any errors in the project command. The project creation is complete. Next Step - Automating Project Information In the next section we will build the logic to read information about a project and display it to the user in Visual Studio. Automate Project Information Return To Create Project Guidance The link below will take you back to the create project guidance. Create Project Guidance"
+    "keywords": "Creating a Project The first step will be to create a project and register our first command. Background The following is important background information on CodeFactory itself. This will help you understand the default startup behavior the first time you create a CodeFactory project. NuGet CodeFactory was designed to load the target versions of the SDK libraries directly from NuGet. The way that this is accomplished is by adding direct project references to the target version hosted on NuGet. With the legacy project system used to host .Net framework it does not automatically pull down these NuGet packages when you load the project for the first time. So if any CodeFactory project items are added you will get a number of errors related to the libraries not being loaded. The NuGet packages will automatically be pulled down the first time you do a build (Ctrl-Shift-B) of the project itself, these errors will then go away. CodeFactory Packager A CodeFactory commands project is the main execution point for all CodeFactory automation. This project will automatically execute a command line utility after the compile of the project has completed. The CFXPackager utility is responsible for building the CFX file that is used to run CodeFactory automation. If no commands are defined in the project this utiltity will output a error saying the package could not be built. This error will go away once the first command is added to the project. Walk-through Steps Follow these steps to successfully create and compile your CodeFactory project: Start Visual Studio 2019 From the \"What would you like to do?\" window click \"Create a new project\". Or you can start the same process if you dont use the start up window. Click the File menu From the context menu select New From the sub-context menu select Project From the \"Create a new project\" window do the following: In the search box type CodeFactory From The list of projects select \"CodeFactory - Commands Library\" Click \"Next\" From the \"Configure your new project\" window do the following: In the \"project name\" box type \"DisplayProjectCommands\" Click Create Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the sub-folders. The following is a brief overview of the goal for each folder. Important note: each Explorer Command has its own folder. The following structure is prescriptive only. You can create any folder structure you wish for your automation. The Project folder is where project commands are created and stored The Dialog folder is for placement of user interface dialogs you created. The Logic folder is where you add logic that can be reused across multiple project commands The Template folder is where you add T4 template that are used by project commands. Next we will add a solution explorer project command to the project. Do the following steps: Right click on the project folder in solution explorer From the context menu select Add From the sub context menu select New Item... From the Add New Item Dialog Window do the following: From the Visual C# Items select CodeFactory Select Solution Explorer - Project Command In the name box enter ProjectInformationCommand.cs Then click Add A Microsoft Visual Studio error box will appear. This error occurs because the CodeFactory SDK NuGet packages have not been downloaded into the project yet. This is normal. Click Ok to continue. The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through NuGet yet. We will then Build the solution which will trigger the pull of the NuGet packages. Do the following: From the top navigation bar click on Build From the context menu click Build Solution Once the build has completed it will have downloaded and installed the NuGet packages into the project. You will now see the CodeFactorySDK reference in the project. You will also notice there are no longer any errors in the project command. The project creation is complete. Next Step - Automating Project Information In the next section we will build the logic to read information about a project and display it to the user in Visual Studio. Automate Project Information Return To Create Project Guidance The link below will take you back to the create project guidance. Create Project Guidance"
   },
   "guidance/howto/CreateProject/Overview.html": {
     "href": "guidance/howto/CreateProject/Overview.html",

docs/manifest.json

@@ -73,15 +73,12 @@
       "version": ""
     },
     {
-      "log_codes": [
-        "InvalidFileLink"
-      ],
       "type": "Conceptual",
       "source_relative_path": "guidance/Introduction/Overview.md",
       "output": {
         ".html": {
           "relative_path": "guidance/Introduction/Overview.html",
-          "hash": "fxZDv1pXH/y4kleYrkcsnA=="
+          "hash": "LuYgyIL8qt4Lo2VVkoUOoA=="
         }
       },
       "is_incremental": false,
@@ -129,7 +126,7 @@
       "output": {
         ".html": {
           "relative_path": "guidance/howto/CreateProject/CreateProject.html",
-          "hash": "TXRyIu+2D2D8LwOX4He1iQ=="
+          "hash": "RQQ2azju+ueJybvZZJuhPg=="
         }
       },
       "is_incremental": false,

src/CodeFactoryVisualStudio/Documentation/guidance/Introduction/Overview.md

@@ -36,4 +36,4 @@ Review of how user interfaces can be created and used within the Visual Studio e
 ## CodeFactory Guidance
 A variety of "walk-through" scenario-driven guidance is provided to help you get started and understand how to use the CodeFactory SDK.
 
-[CodeFactory Guidance](../Guidance/Overview.md)
+[CodeFactory Guidance](../howto/Overview.md)