Merge pull request #34 from PTCInc/23-feat-doc-1_0_0-release-documentation-updates

Feat(doc): 1.0.0 release documentation updates

Author: rlabbeptc

.github/workflows/docfx-build-and-push.yml

@@ -1,6 +1,6 @@
 # Your GitHub workflow file under .github/workflows/
 # Trigger the action on push to main
-name: Docfx Builder
+name: Docfx Builder and Publisher for Web Pages
 
 on:
   workflow_dispatch:
@@ -12,7 +12,7 @@ on:
       - 'KepwareSync.Service/**'
       - 'docs/docfx/**'
       - '.github/workflows/dotnet.yml' 
-      - '!**/*.md' # Exclude markdown files
+      # - '!**/*.md' Exclude markdown files
   # pull_request:
   #   branches: [ "main" ]
   #   paths:
@@ -53,10 +53,14 @@ jobs:
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.x
+    # Updates repo README.md to be index page for website
     - name: Modify markdown file to be index page
       run: |
         sed -i '1i ---\noutputFileName: index.html\n---' ./README.md
-    - run: cp ./README.md ./docs/docfx/
+    # Copys markdown files to docfx folder to be used in docfx build
+    - name: Run markdown copy script
+      run: ./docs/docfx/copy_md_files.ps1
+    # - run: cp ./README.md ./docs/docfx/
     - run: dotnet tool update -g docfx
     - run: docfx ./docs/docfx/docfx.json
 

.gitignore

@@ -6,6 +6,8 @@
 # Custom ignore files
 docs/docfx/api/
 docs/docfx/_*
+docs/docfx/Kepware*
+docs/docfx/*.md
 
 # User-specific files
 *.rsuser

Kepware-ConfigAPI-SDK-dotnet.sln

@@ -10,6 +10,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionFiles", "SolutionFi
 		.copilot.json = .copilot.json
 		.dockerignore = .dockerignore
 		.gitignore = .gitignore
+		.runsettings = .runsettings
 		Directory.Build.props = Directory.Build.props
 		LICENSE.txt = LICENSE.txt
 		README.md = README.md
@@ -37,16 +38,23 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kepware.Api.Test", "Kepware
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{8BD77CD2-2CB2-4EBE-B806-C4A5C8321DF1}"
 	ProjectSection(SolutionItems) = preProject
+		docs\nuget-README.md = docs\nuget-README.md
 		docs\repo-guidelines.md = docs\repo-guidelines.md
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docfx", "docfx", "{EF3D2F75-E504-4800-A182-6BFB98C31225}"
 	ProjectSection(SolutionItems) = preProject
+		docs\docfx\copy_md_files.ps1 = docs\docfx\copy_md_files.ps1
 		docs\docfx\docfx.json = docs\docfx\docfx.json
 		docs\docfx\README.md = docs\docfx\README.md
 		docs\docfx\toc.yml = docs\docfx\toc.yml
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{457CB96C-D60B-4994-B87C-BCDBF4035D58}"
+	ProjectSection(SolutionItems) = preProject
+		docs\docfx\docs\toc.yml = docs\docfx\docs\toc.yml
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -77,6 +85,7 @@ Global
 		{F0A34611-31AD-4698-A368-4D65F9A0F9D9} = {A904D930-41F6-4016-A8BE-AED91D9E5B26}
 		{8BD77CD2-2CB2-4EBE-B806-C4A5C8321DF1} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
 		{EF3D2F75-E504-4800-A182-6BFB98C31225} = {8BD77CD2-2CB2-4EBE-B806-C4A5C8321DF1}
+		{457CB96C-D60B-4994-B87C-BCDBF4035D58} = {EF3D2F75-E504-4800-A182-6BFB98C31225}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {B60B443A-DDB4-4D93-AF9F-547702A8492E}

Kepware.Api.Sample/Program.cs

@@ -19,7 +19,7 @@ static async Task Main(string[] args)
                         name: "sample",
                         baseUrl: "https://localhost:57512",
                         apiUserName: "Administrator",
-                        apiPassword: "InrayTkeDocker2024!",
+                        apiPassword: "ReallyStrongPassword400!",
                         disableCertificateValidation: true
                         );
                 })

Kepware.Api.Sample/README.md

@@ -89,9 +89,9 @@ static async Task Main(string[] args)
 ```
 
 ## Licensing
-This sample project is provided "as is" under the MIT License. See the [LICENSE](./LICENSE.txt) file for details.
+This sample project is provided "as is" under the MIT License. See the [LICENSE](../LICENSE.txt) file for details.
 
 ## Support
 For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository. 
 
-See [Repository Guidelines](./docs/repo-guidelines.md) for more information.
+See [Repository Guidelines](../docs/repo-guidelines.md) for more information.

Kepware.Api/ClientHandler/AdminApiHandler.cs

@@ -14,11 +14,19 @@
 
 namespace Kepware.Api.ClientHandler
 {
+    /// <summary>
+    /// Handles operations related to administrative settings and configurations in the Kepware server.
+    /// </summary>
     public class AdminApiHandler
     {
         private readonly KepwareApiClient m_kepwareApiClient;
         private readonly ILogger<AdminApiHandler> m_logger;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AdminApiHandler"/> class.
+        /// </summary>
+        /// <param name="kepwareApiClient">The Kepware Configuration API client.</param>
+        /// <param name="logger">The logger instance.</param>
         public AdminApiHandler(KepwareApiClient kepwareApiClient, ILogger<AdminApiHandler> logger)
         {
             m_kepwareApiClient = kepwareApiClient;

Kepware.Api/ClientHandler/ChannelApiHandler.cs

@@ -8,6 +8,9 @@
 
 namespace Kepware.Api.ClientHandler
 {
+    /// <summary>
+    /// Handles operations related to channel configurations in the Kepware server.
+    /// </summary>
     public class ChannelApiHandler
     {
         private readonly KepwareApiClient m_kepwareApiClient;
@@ -16,15 +19,14 @@ public class ChannelApiHandler
         /// <summary>
         /// Initializes a new instance of the <see cref="ChannelApiHandler"/> class.
         /// </summary>
-        /// <param name="kepwareApiClient">The Kepware API client.</param>
+        /// <param name="kepwareApiClient">The Kepware Configuration API client.</param>
         /// <param name="logger">The logger instance.</param>
         public ChannelApiHandler(KepwareApiClient kepwareApiClient, ILogger<ChannelApiHandler> logger)
         {
             m_kepwareApiClient = kepwareApiClient;
             m_logger = logger;
         }
 
-        #region Channels
         #region GetOrCreateChannelAsync
         /// <summary>
         /// Gets or creates a channel with the specified name and driver.
@@ -153,6 +155,5 @@ public Task<bool> DeleteChannelAsync(string channelName, CancellationToken cance
             return m_kepwareApiClient.GenericConfig.DeleteItemAsync<Channel>(channelName, cancellationToken: cancellationToken);
         }
         #endregion
-        #endregion
     }
 }

Kepware.Api/ClientHandler/DeviceApiHandler.cs

@@ -9,6 +9,9 @@
 
 namespace Kepware.Api.ClientHandler
 {
+    /// <summary>
+    /// Handles operations related to device configurations in the Kepware server.
+    /// </summary>
     public class DeviceApiHandler
     {
         private readonly KepwareApiClient m_kepwareApiClient;