added docs

BlueByteSystemsInc · May 3, 2024 · 9f23240 · 9f23240
1 parent 444a75a
commit 9f23240
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 4 deletions.
diff --git a/docs/docs/updating_nuget_packages.html b/docs/docs/updating_nuget_packages.html
@@ -2,9 +2,9 @@
 <html>
   <head>
     <meta charset="utf-8">
-      <title> | SOLIDWORKS PDM SDK </title>
+      <title>Using the Package Manager Console | SOLIDWORKS PDM SDK </title>
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <meta name="title" content=" | SOLIDWORKS PDM SDK ">
+      <meta name="title" content="Using the Package Manager Console | SOLIDWORKS PDM SDK ">
 
 
       <link rel="icon" href="../favicon.ico">
@@ -86,6 +86,37 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
         <article data-uid="">
 
+<p>To fully utilize the latest features and bug fixes of the SDK, please make sure you are using the latest version of the BlueByte.PDMProfessional.SDK nuget package.</p>
+<div class="NOTE">
+<h5>Note</h5>
+<p>BlueByte.PDMProfessional.SDK targets .NET framework 4.7.2. For more information, check out the nuget package <a href="https://www.nuget.org/packages/BlueByte.SOLIDWORKS.PDMProfessional.SDK">page</a>.</p>
+</div>
+<p>The latest version of the nuget is:  <a href="https://www.nuget.org/packages/BlueByte.SOLIDWORKS.PDMProfessional.SDK"><img src="https://img.shields.io/nuget/v/BlueByte.SOLIDWORKS.PDMProfessional.SDK.svg?style=flat-square" alt="NuGet version (BlueByte.SOLIDWORKS.PDMProfessional.SDK)"></a></p>
+<h1 id="using-the-package-manager-console">Using the Package Manager Console</h1>
+<p>In Visual Studio:</p>
+<ul>
+<li>Press Ctrl + Q. This is going to highlight the search box at the top of the window.</li>
+<li>Type Nuget Package Manager Console and pick the first search result.</li>
+<li>A new window will appear. Allow a couple of seconds for the package manager to initialize.</li>
+<li>Type in the following command (and press enter):</li>
+</ul>
+<p><code>Update-Package BlueByte.SOLIDWORKS.PDMProfessional.SDK</code></p>
+<ul>
+<li><p>The command above will install the package in the active project. If you have multiple projects and you need to specify the one that needs to update the SDK nuget pacakge, use the <code>-project</code> argument to specify the project name. Example: <code>Update-Package BlueByte.SOLIDWORKS.PDMProfessional.SDK -project MyAddInProject</code></p>
+</li>
+<li><p>The Package Manager Console will report back that package has been installed successfully.</p>
+</li>
+</ul>
+<h1 id="using-the-package-manager">Using the Package Manager</h1>
+<p>In Visual Studio,</p>
+<ul>
+<li>Locate the add-in's project in the <em>Solution Explorer</em></li>
+<li>Right-click on the project and click <em>Manage Nuget Packages...</em></li>
+<li>The Package Manager window will open. Locate and select the BlueByte.SOLIDWORKS.PDMProfessional.SDK nuget package in the installed tab.</li>
+<li>Depending on the version of the SDK template, you may be to update the package if there is a new version. If an update is available, select the nuget package.</li>
+<li>The properties of the package will update on the right-side of the window and you are able to pick the latest available version from the version dropdown.</li>
+</ul>
+<img src="../images/update_nuget_package.png">
 
 </article>
 

diff --git a/docs/images/update_nuget_package.png b/docs/images/update_nuget_package.png
diff --git a/docs/index.json b/docs/index.json
@@ -181,8 +181,8 @@
   },
   "docs/updating_nuget_packages.html": {
     "href": "docs/updating_nuget_packages.html",
-    "title": "| SOLIDWORKS PDM SDK",
-    "keywords": ""
+    "title": "Using the Package Manager Console | SOLIDWORKS PDM SDK",
+    "keywords": "To fully utilize the latest features and bug fixes of the SDK, please make sure you are using the latest version of the BlueByte.PDMProfessional.SDK nuget package. Note BlueByte.PDMProfessional.SDK targets .NET framework 4.7.2. For more information, check out the nuget package page. The latest version of the nuget is: Using the Package Manager Console In Visual Studio: Press Ctrl + Q. This is going to highlight the search box at the top of the window. Type Nuget Package Manager Console and pick the first search result. A new window will appear. Allow a couple of seconds for the package manager to initialize. Type in the following command (and press enter): Update-Package BlueByte.SOLIDWORKS.PDMProfessional.SDK The command above will install the package in the active project. If you have multiple projects and you need to specify the one that needs to update the SDK nuget pacakge, use the -project argument to specify the project name. Example: Update-Package BlueByte.SOLIDWORKS.PDMProfessional.SDK -project MyAddInProject The Package Manager Console will report back that package has been installed successfully. Using the Package Manager In Visual Studio, Locate the add-in's project in the Solution Explorer Right-click on the project and click Manage Nuget Packages... The Package Manager window will open. Locate and select the BlueByte.SOLIDWORKS.PDMProfessional.SDK nuget package in the installed tab. Depending on the version of the SDK template, you may be to update the package if there is a new version. If an update is available, select the nuget package. The properties of the package will update on the right-side of the window and you are able to pick the latest available version from the version dropdown."
   },
   "index.html": {
     "href": "index.html",

diff --git a/docs/manifest.json b/docs/manifest.json
@@ -456,6 +456,16 @@
       },
       "version": ""
     },
+    {
+      "type": "Resource",
+      "source_relative_path": "images/update_nuget_package.png",
+      "output": {
+        "resource": {
+          "relative_path": "images/update_nuget_package.png"
+        }
+      },
+      "version": ""
+    },
     {
       "type": "Conceptual",
       "source_relative_path": "index.md",