Merge branch 'Docs' of https://github.com/CodeFactoryLLC/CodeFactory into Docs

Author: sgiffinlcd

Docs/Introduction/Commands/Overview.md

@@ -1,35 +1,34 @@
 # CodeFactory Commands
 When working with CodeFactory you always start with commands. 
-Commands are the trigger point where all CodeFactory functionality starts from. 
-As of this release of CodeFactory all commands are triggered from context menus on individual nodes within solution explorer. As per the name a command following a command exection pattern. 
-This is made up of two methods that are raised from internal events that occur within Visual Studio itself. These events are trigged when a selected solution explorers item content menu is opened. 
-The following explain the two methods their goal and the different type of commands that are supported in CodeFactory.
+Commands are the trigger point where all CodeFactory functionality originates. 
+Currently all commands are triggered from context menus on individual nodes within Solution Explorer. Each command is comprised of two methods which are raised from internal events that occur within Visual Studio. These events are trigged when a selected Solution Explorer's item content menu is opened. 
+The following describes each of the two methods, their purpose and the different types of commands that are supported in CodeFactory.
 
 ## Command Result
-Whenever a command is executed a real time data model is generated based on the type of Visual Studio object that has been selected. The data model is regenerated each time the target command is executed. 
+Whenever a command is executed, a real time data model is generated based on the type of Visual Studio object that has been selected. The data model is instantly regenerated behind-the-scenes each time the target command is executed. 
 
 ## Enable Command
-When a command is first loaded it sends the command result to the enable method on the command.
-This method is called to allow the author of the command to determine if the command should be enabled to be used. 
-This was added to allow the author to control execution of automation. 
-You may only want automation to be enabled based on a target condition.
+When a command is first loaded, it sends the command result to the enable method on the command.
+This method is called to allow the author of the command to determine whether the command should be visible or hidden to the automation user for use. 
+This feature exists in order to allow automation authors to control execution of automation by hiding or showing commands on the context menu as they desire. 
+
 This is controlled by simply returning a true or false value to determine if the command should be accessible.
-If enabled is true the command will show up in the context menu. 
-The developer in Visual Studio will then trigger the command to execute by selecting the context menu item.
+If enabled is true, the command will appear inside the context menu. 
+The developer in Visual Studio can then trigger the command to execute by selecting the context menu item.
 
 ## Execute Command
-Once the developer selects a command to be executed Visual Studio will trigger the execute method of the command itself. 
-Like before a real time data model is passed to the execute method. 
-This is where the automation process starts and whatever functionality has been assigned will executed at this time.
+Once the developer selects a command to be executed, Visual Studio will run the execute method of the command itself. 
+Like before, a real time data model is instantly passed to the execute method. 
+This is when the automation process starts, and whatever functionality has been authored, will be executed at this time.
 
-## Solution Explore Commands
-CodeFactory current supports the trigger of commands from the solution explorer window in Visual Studio.
-The following are the supported Solution Explorer nodes that will CodeFactory Automation.
+## Solution Explorer Commands
+CodeFactory current supports the trigger of commands from the Solution Explorer window within Visual Studio.
+The following are the supported Solution Explorer nodes that can interact with CodeFactory automation commands:
 
- - Solution Command - Generates a Solutiuon data model
- - SolutionFolder Command - Generates a Solution Folder data model
- - SolutionDocument Command - Generates a Document data model
+ - Solution Command - Generates a Solution data model
+ - SolutionFolder Command - Generates a SolutionFolder data model
+ - SolutionDocument Command - Generates a SolutionDocument data model
  - Project Command - Generates a Project data model
- - Project Folder - Generates a Project Folder data model
+ - ProjectFolder - Generates a ProjectFolder data model
  - Document Command - Generates a Document data model
  - C# Document Command - Generates a CSharpSource data model

Docs/Introduction/Data Models/Overview.md

@@ -1,70 +1,69 @@
-# CodeFactory DataModels
-The primary strength of CodeFactory is its ability to generate real time data models directly from the Visual Studio environment. 
-This ability makes it possible to do design time automation when delivering software. In this section we will provide a brief overview of the data models that are generated dynamically by the CodeFactory platform. These data models are used throughout the automation process.
+# CodeFactory Data Models
+The primary strength of CodeFactory is its ability to generate real time data models directly from your project/solution artifacts within the Visual Studio IDE. 
+This ability makes it possible to do design-time automation when delivering software. In this section we will provide a brief overview of the data models that are generated dynamically by the CodeFactory platform. These data models are used throughout the automation process.
 
 ## Data Models
-All data models are plain old CLR objects or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since an change to the underlying data model requires a complete regeneration of the data model from the visual studio environment to make sure you have the latest version of all data.
-
-Data model generation is either triggered during the trigger of a new automation process, or from various CodeFactory API calls that will request new copies of data models.
+All data models are "plain old CLR objects" or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since a change to the underlying data model requires a complete regeneration of the data model from the Visual Studio environment to make sure you have the latest version of all data.  For example, making a change to a C# class object would force CodeFactory to regenerate a data model of that file/class object.
 
+Data model generation is either triggered during the execution of a new automation process, or from various CodeFactory API calls that will request new copies of data models.
 
 ## Solution Explorer Models (Project System)
 The following models are directly generated off the legacy and new project systems that are hosted by Visual Studio.
-The overview of each data model is designed to provide an overview of capabilties. It will not list every single data element or function. See help docs for the full description if each data model.
+The overview of each data model is designed to provide an overview of capabilties. The examples here are not complete and only reflect partial functionality for the purpose of explanation.  Please see our help docs for the full description of each data model.
 
 ### Solution
-Data model that represents the loaded solution. This provides the location of the solution as well as access to the projects in the solution.
+Data model that represents the loaded solution. This provides the location of the solution as well as access to the projects within the solution.
 
 ### Solution Folder
-Data model that represents a virtual folder that is at scope of the solution level. This provides acess to the name of the folder and the children that are hosted in this folder.
+Data model that represents a virtual folder that is at scope of the solution level. This provides acess to the name of the folder and the children objects which are hosted within this folder.
 
 ### Project
-Data model that represents a loaded project that is managed in the solution. this provides access to the project location and name, and access to all children objects hosted in the project.
+Data model that represents a loaded project that is managed in the solution. This provides access to the project location and name, and access to all children objects hosted in the project.
 
 ### Project Reference
-Data model that represents a reference to a project hosted in the solution. This provides the name of the reference and the target artifact that is being referenced.
+Data model that represents a reference to a project hosted within the solution. This provides the name of the reference and the target artifact that is being referenced.
 
 ### Project Folder
-The project folder model represents a folder under a target project. This will contain the path and name of the folder and the list of child objects that are managed under this project folder.
+Project folder model represents a folder under a target project. This will contain the path and name of the folder and the list of child objects which are managed under this project folder.
 
 ### Document
-Model that represents a file that is hosted in a project, project folder, or solution folder. This will contain the path and the name of the file. As well as access to the full contents in the document itself. 
+Document model represents a file which is hosted within a project, project folder, or solution folder. This will contain the path and the name of the file, as well as access to the full contents of the document itself. 
 
 ### C# Source Document
-The C# source document project system access as well as full access to the C# source code that is hosted in the document itself. 
+C# Source Document provides project system access, as well as full access to the C# source code which is hosted within the document itself. 
 
 ## C# Language Models - (Source Code)
-CodeFactory has access to the C# language compiler and can dynamically generate data models the represent the C# based source code. 
+CodeFactory has access to the C# language compiler and can dynamically generate data models that represent the C#-based source code. 
 CodeFactory provides direct access all the way down to member and type level data. 
-In addition, will give you direct access to the raw source code at the target object level. 
-The following are the data models that are generated whenever either accessing from source code files, or from directly referenced assemblies. 
-The overview of each data model is designed to provide an overview of capabilties. It will not list every single data element or function. See help docs for the full description if each data model.
+In addition, CodeFactory will provide direct access to the raw source code at the target object level. 
+The following data models are auto-generated whenever accessing  source code files or directly referenced assemblies. 
+The overview of each data model is designed to provide an example of capabilties and does not list every single data element or function. Please see our help docs for the full description of each data model.
 
-### Soure Code
-The source code data model provides access to all elements that were compiled from the source code document. This includes the following.
+### Source Code
+The Source Code model provides access to all elements that were compiled from the source code document. This includes the following:
  - Namespaces
  - Using Statements
  - Classes
  - Interfaces
  - Structures
 
 ### Using Statement
-Using statement provides information on target namespaces to use in the code base. This includes the following.
+Using Statement model provides information on targeted namespaces to use in the code base. This includes the following:
  - Namespace
  - Alias
 
 ### Namespace Statement
-Namespace model provides the target namespace that other c# code elements are contained in. 
+Namespace model provides the target namespace that other C# code elements are contained in. 
 
 ### Attribute
-Attribute provides a data model of the type of the attribute and the parameters that have been assigned to the attribute. This includes the following
+Attribute provides a data model of the type of attribute and parameters which have been assigned to the attribute. This includes the following:
  - Name
  - Namespace
  - Named Parameters
  - Constructor Parameters
 
 ### Attribute Parameter
-Data model that provides the data for a target parameter on an attribute. This includes the following.
+Data model that provides the data for a target parameter on an attribute. This includes the following:
  - Name (Optional)
  - Parameter values
 
@@ -75,7 +74,7 @@ Data model that provides a target value that is assigned to an attribute paramet
 Enum data model provides the definition of an enumeration and the target values of the enumeration.
 
 ### Class
-The Class data model provides data on a target class hosted in source code. This will include the following.
+The Class data model provides data on a target class hosted in source code. This will include the following:
  - Attributes
  - Name
  - Namespace
@@ -85,7 +84,7 @@ The Class data model provides data on a target class hosted in source code. This
  - Members (Events, Fields, Methods, Properties)
 
 ### Interface
-The Interface data model provides data on the target interface definition in source code. This will include the following.
+The Interface data model provides data on the target interface definition in source code. This will include the following:
  - Attributes
  - Name
  - Namespace
@@ -96,7 +95,7 @@ The Interface data model provides data on the target interface definition in sou
 
 
 ### Structure
-The structure data model provides data on the target structure definition in source code. This will include the following.
+The Structure data model provides data on the target structure definition in source code. This will include the following:
  - Attributes
  - Name
  - Namespace
@@ -106,14 +105,14 @@ The structure data model provides data on the target structure definition in sou
  - Members (Events, Fields, Methods, Properties)
 
 ### Delegate
-The delegate model provides data on the definition of a delegate in source code. This will include the following.
+The Delegate model provides data on the definition of a delegate in source code. This will include the following:
 - Name
 - Namespace
 - Parameters
 - Return type
 
 ### Event 
-The event data model provides data on the definition of an event in source code. This will include the following.
+The Event data model provides data on the definition of an event in source code. This will include the following:
  - Attributes
  - Name
  - Type
@@ -122,7 +121,7 @@ The event data model provides data on the definition of an event in source code.
  - EventHandlerMethod Definition
 
 ### Field
-The field data model provides data on the definition of a field in source code. This will include the following.
+The Field data model provides data on the definition of a field in source code. This will include the following:
 
  - Attributes
  - Name
@@ -132,7 +131,7 @@ The field data model provides data on the definition of a field in source code.
  - Assigned value
 
 ### Method
-The method data model provides data on the definition of a method in source code. This will include the following.
+The Method data model provides data on the definition of a method in source code. This will include the following:
  - Attributes
  - Name
  - Security Scope
@@ -142,26 +141,26 @@ The method data model provides data on the definition of a method in source code
  - Method Type
 
 ### Property
-The property data model provides data on the definition of a property in source code. This will include the following.
+The Property data model provides data on the definition of a property in source code. This will include the following:
  - Attributes
  - Name
  - Type
- - Propery Security
+ - Property Security
  - Keywords
  - Has Get
  - Get Security
  - Has Set
  - Set Security
 
 ### Parameter
-The Parameter data model provides data on the definition of a parameter in a method or a delegate. This will include the following.
+The Parameter data model provides data on the definition of a parameter in a method or a delegate. This will include the following:
  - Attributes
  - Name
  - Keywords
  - Default value
 
 ### Type
- The type datamodel provides information about a type that is used in all the above source code definition. This will include the following.
+ The Type data model provides information about a type that is used in all the above source code definitions. This will include the following:
  - Name
  - Namespace
  - IsValueType