Merge pull request #7 from werebear73/development

Documentation Enhancements

.pages

@@ -0,0 +1,2 @@
+nav:
+  - ...

BoxContains.sln

@@ -5,8 +5,8 @@ VisualStudioVersion = 17.11.35219.272
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{E4D23527-A7AB-42CC-AC70-1BF04361125C}"
 	ProjectSection(SolutionItems) = preProject
+		.pages = .pages
 		docs\index.md = docs\index.md
-		docs\stylesheets\tables.css = docs\stylesheets\tables.css
 		docs\versions.md = docs\versions.md
 	EndProjectSection
 EndProject
@@ -38,6 +38,9 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{D9AB8F32-923D-4987-ABD8-B2F54E50644F}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "BoxContains.Category", "BoxContains.Category", "{4DEBF082-4774-4B30-ABBB-1B3993E00B1D}"
+	ProjectSection(SolutionItems) = preProject
+		src\BoxContains.Category\mkdocs.yml = src\BoxContains.Category\mkdocs.yml
+	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{84B56482-F18D-418F-AB18-6C657BA69206}"
 EndProject
@@ -61,10 +64,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BoxContains.Category.Integr
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BoxContains.Category.Docker", "src\BoxContains.Category\src\interfaces\BoxContains.Category.Docker\BoxContains.Category.Docker.csproj", "{42289CC8-9112-40EC-8AAD-2973C1075FDE}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BoxContains.Interface.Shared", "BoxContains.Interface.Shared\BoxContains.Interface.Shared.csproj", "{3191740B-CBCE-47AB-AE11-42A807AEA711}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BoxContains.Interface.Web", "BoxContains.Interface.Web\BoxContains.Interface.Web.csproj", "{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{51FAD0FF-C6A8-4359-821F-D8F68E4A2BD5}"
 	ProjectSection(SolutionItems) = preProject
 		docs\assets\favicon-32x32.png = docs\assets\favicon-32x32.png
@@ -75,15 +74,20 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "stylesheets", "stylesheets"
 		docs\stylesheets\tables.css = docs\stylesheets\tables.css
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{F19A68FD-B8C2-4B31-B068-280A67CFF629}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{10E38034-7CDB-4986-ABDA-2B087CAF7555}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{3C867764-E421-4262-9D91-FE144FB0D1DB}"
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\docs.yml = .github\workflows\docs.yml
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{47A1215F-6F1A-4953-A396-5E04EFA3C387}"
+	ProjectSection(SolutionItems) = preProject
+		src\BoxContains.Category\docs\index.md = src\BoxContains.Category\docs\index.md
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "deployment", "deployment", "{46E39F4C-8C37-4768-9825-3BA57B931C79}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -114,14 +118,6 @@ Global
 		{42289CC8-9112-40EC-8AAD-2973C1075FDE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{42289CC8-9112-40EC-8AAD-2973C1075FDE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{42289CC8-9112-40EC-8AAD-2973C1075FDE}.Release|Any CPU.Build.0 = Release|Any CPU
-		{3191740B-CBCE-47AB-AE11-42A807AEA711}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{3191740B-CBCE-47AB-AE11-42A807AEA711}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{3191740B-CBCE-47AB-AE11-42A807AEA711}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{3191740B-CBCE-47AB-AE11-42A807AEA711}.Release|Any CPU.Build.0 = Release|Any CPU
-		{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -140,12 +136,11 @@ Global
 		{622D6352-01C5-4B62-A211-759E65990247} = {84B56482-F18D-418F-AB18-6C657BA69206}
 		{97965502-A55A-455B-8812-33891FE638B3} = {7095DAF5-AE01-4CE8-9469-41AE9EA5D869}
 		{42289CC8-9112-40EC-8AAD-2973C1075FDE} = {622D6352-01C5-4B62-A211-759E65990247}
-		{3191740B-CBCE-47AB-AE11-42A807AEA711} = {622D6352-01C5-4B62-A211-759E65990247}
-		{0BCC6F6D-7C6C-45D1-AA8A-D35C3B6DE6F1} = {622D6352-01C5-4B62-A211-759E65990247}
 		{51FAD0FF-C6A8-4359-821F-D8F68E4A2BD5} = {E4D23527-A7AB-42CC-AC70-1BF04361125C}
 		{16F9D0C9-F36F-47A1-81C9-F7E7FC4D59D8} = {E4D23527-A7AB-42CC-AC70-1BF04361125C}
-		{F19A68FD-B8C2-4B31-B068-280A67CFF629} = {4DEBF082-4774-4B30-ABBB-1B3993E00B1D}
 		{3C867764-E421-4262-9D91-FE144FB0D1DB} = {10E38034-7CDB-4986-ABDA-2B087CAF7555}
+		{47A1215F-6F1A-4953-A396-5E04EFA3C387} = {4DEBF082-4774-4B30-ABBB-1B3993E00B1D}
+		{46E39F4C-8C37-4768-9825-3BA57B931C79} = {47A1215F-6F1A-4953-A396-5E04EFA3C387}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {5663B815-F037-4462-9822-97BF6477EF1B}

docs/index.md

@@ -24,18 +24,6 @@ This project follows the following folder structure:
 Root Folder contains the README, License, Solution File, and any other files required to be there.
 ```
 
-## API Microservices
-
-### Build Category API
-``` bash
- docker build -t box-contains-category_api:dev -f .\src\BoxContains.Category\src\interfaces\BoxContains.Category.Docker\Dockerfile .
-```
-
-### Launch Category API
-``` bash
-docker run -p 8080:8080 --name=box-contains-category_api_dev_ box-contains-category_api:dev 
-```
-
 ## Notes
 1. I don't normally embed projects this but I wanted the entire in a single Git Repository so src has this additional layer
 

docs/requirements/v1.0/business_requirements.md

@@ -4,23 +4,23 @@
 ![Process Decomposition Diagram](process_decomposition_diagram.svg)
 ### Process List
 1. Track Storage Containers
-   1. [Add a Storage Container](####add-a-storage-container)
-   1. [Edit a Storage Container](####edit-a-storage-container)
-   1. [List Storage Containers](####list-storage-containers)
-   1. [Get Storage Container Details](####get-storage-container-details)
-   1. [Delete a Storage Container](####delete-a-storage-container)
+   1. [Add a Storage Container](#add-a-storage-container)
+   1. [Edit a Storage Container](#edit-a-storage-container)
+   1. [List Storage Containers](#list-storage-containers)
+   1. [Get Storage Container Details](#get-storage-container-details)
+   1. [Delete a Storage Container](#delete-a-storage-container)
 1. Track Categories
-   1. [Add a Category](####add-a-category)
-   1. [Edit a Category](####edit-a-category)
-   1. [List Categories](####list-categories)
-   1. [Get Category Details](####get-category-details)
-   1. [Delete a Category](####delete-a-category)
+   1. [Add a Category](#add-a-category)
+   1. [Edit a Category](#edit-a-category)
+   1. [List Categories](#list-categories)
+   1. [Get Category Details](#get-category-details)
+   1. [Delete a Category](#delete-a-category)
 1. Track Items
-   1. [Add an Item](####add-an-item)
-   1. [Edit an Item](####edit-an-item)
-   1. [List All Items](####list-all-items)
-   1. [Get Item Details](####get-item-details)
-   1. [Delete a Item](####delete-a-item)
+   1. [Add an Item](#add-an-item)
+   1. [Edit an Item](#edit-an-item)
+   1. [List All Items](#list-all-items)
+   1. [Get Item Details](#get-item-details)
+   1. [Delete a Item](#delete-a-item)
 
 ### Process Details
 ___

mkdocs.yml

@@ -22,6 +22,12 @@ theme:
     code: Roboto Mono
   favicon: assets/favicon-32x32.png
 
+nav:
+  - Home: index.md
+  - Project Documentation:
+    - ...
+  - Microservices:
+    - Category API Microservice: '!include ./src/BoxContains.Category/mkdocs.yml'
 
 markdown_extensions:
   - meta
@@ -36,8 +42,8 @@ markdown_extensions:
       toc_depth: 4
 plugins:
   - search
-  - monorepo
   - awesome-pages
+  - monorepo
   - minify:
       minify_html: true
 

src/BoxContains.Category/docs/index.md

@@ -0,0 +1,3 @@
+# Box Contents - Category API Microservice
+
+The microservice for managing the categories for the Box Contains project.

src/BoxContains.Category/mkdocs.yml

@@ -0,0 +1,53 @@
+site_name: Box Contains - Category API Microservice
+site_description: This project is tracking the categories of items to be tracked.
+dev_addr: 0.0.0.0:8000
+repo_name: werebear73/BoxContains
+repo_url: https://github.com/werebear73/BoxContains
+edit_uri: edit/main/docs
+docs_dir: docs/
+theme:
+  name: material
+  logo: 
+  palette:
+    primary: white
+    accent: black
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - navigation.instant
+    - header.autohide
+    - toc.integrate
+  font:
+    text: Roboto
+    code: Roboto Mono
+  favicon: assets/favicon-32x32.png
+
+nav:
+  - Home: index.md
+
+markdown_extensions:
+  - meta
+  - admonition
+  - attr_list
+  - def_list
+  - tables
+  - abbr
+  - footnotes
+  - md_in_html
+  - toc:
+      toc_depth: 4
+plugins:
+  - search
+  - monorepo
+  - awesome-pages
+  - minify:
+      minify_html: true
+
+extra_css:
+  - stylesheets/tables.css
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/werebear73
+copyright: Copyright &copy; 2024 <a href="https://weretech.services">Waretech Services LLC</a>