From a0492aaa0b3ec03e15d2ee83f6b6453866156620 Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Wed, 4 Sep 2024 21:44:16 -0500 Subject: [PATCH] Documentation Configuration --- Documentation/Content/Welcome.aml | 62 +++++++------------ Documentation/ContentLayout.content | 2 +- Documentation/Documentation.shfbproj | 10 +++ .../849aa079-3d64-4cf1-966f-44af23c73160.md | 14 +++++ Documentation/Help/Home.md | 15 +++-- Documentation/Help/N_CapyKit.md | 2 +- Documentation/Help/N_CapyKit_Attributes.md | 2 +- Documentation/Help/N_CapyKit_Enumerations.md | 2 +- Documentation/Help/N_CapyKit_Extensions.md | 2 +- Documentation/Help/N_CapyKit_Helpers.md | 2 +- Documentation/Help/N_Tests.md | 2 +- Documentation/Help/N_Tests_Helpers.md | 2 +- Documentation/Help/R_Project_Documentation.md | 16 ++--- Documentation/Help/_Sidebar.md | 2 +- .../fa7407d1-9116-4ad7-a9ab-ed094685b070.md | 15 ----- 15 files changed, 71 insertions(+), 79 deletions(-) create mode 100644 Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md delete mode 100644 Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md diff --git a/Documentation/Content/Welcome.aml b/Documentation/Content/Welcome.aml index 59bfe8b..7b71a49 100644 --- a/Documentation/Content/Welcome.aml +++ b/Documentation/Content/Welcome.aml @@ -2,54 +2,36 @@ - This is a sample conceptual topic. You can use this as a starting point for adding more conceptual -content to your help project. + + Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. + Originally born out of the HappyCapy project, CapyKit is now fully open for the community, + offering a wide array of C# utilities and extensions. + + + + Whether you're looking to integrate some handy extensions into your existing project or you're exploring what + CapyKit can do for your next venture, you've come to the right place! +
Getting Started - To get started, add a documentation source to the project (a Visual Studio solution, project, or -assembly and XML comments file). See the Getting Started topics in the Sandcastle Help -File Builder's help file for more information. The following default items are included in this project: + + This documentation is generated directly from the source code and is constantly evolving as the project progresses. + To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). + - - - ContentLayout.content - Use the content layout file to manage the -conceptual content in the project and define its layout in the table of contents. - + + If you're new to the project, bear with us while things are still transitioning from the private repository. + We're working hard to make this resource the best it can be. + - - The .\media folder - Place images in this folder that you will reference -from conceptual content using medialLink or mediaLinkInline -elements. If you will not have any images in the file, you may remove this folder. - - - - The .\icons folder - This contains a default logo for the help file. You -may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update -the Transform Args project properties page by removing or changing the filename in the -logoFile transform argument. Note that unlike images referenced from conceptual topics, -the logo file should have its BuildAction property set to Content. - - - - The .\Content folder - Use this to store your conceptual topics. You may -name the files and organize them however you like. One suggestion is to lay the files out on disk as you have -them in the content layout file as shown in this project but the choice is yours. Files can be added via the -Solution Explorer or from within the content layout file editor. Files must appear in the content layout file -in order to be compiled into the help file. - - - - See the Conceptual Content topics in the Sandcastle Help File Builder's -help file for more information. See the Sandcastle MAML Guide for details on Microsoft -Assistance Markup Language (MAML) which is used to create these topics. + + For a complete overview of the automatically generated documentation, start by exploring the + [API and Utilities Reference](R_Project_Documentation.md) +
- - - - diff --git a/Documentation/ContentLayout.content b/Documentation/ContentLayout.content index 7ba0c2c..5613b7b 100644 --- a/Documentation/ContentLayout.content +++ b/Documentation/ContentLayout.content @@ -1,6 +1,6 @@  - + diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj index d362909..b523cef 100644 --- a/Documentation/Documentation.shfbproj +++ b/Documentation/Documentation.shfbproj @@ -62,6 +62,16 @@ False Msdn True + Welcome to the official documentation for CapyKit, a powerful collection of C# utilities designed to enhance your .NET projects. Below, you&#39%3bll find a list of namespaces included in the library, each offering a unique set of tools, extensions, and helpers to streamline your development process. + + +Core utilities and foundational methods for the CapyKit library. +Custom attributes for simplifying .NET code behavior. +Commonly used enumerations for value comparison and logic. +Extension methods for enhancing .NET classes and simplifying operations. +Utility classes for tasks like data manipulation and reflection. +Unit tests ensuring CapyKit functions as expected. +Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`. diff --git a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md new file mode 100644 index 0000000..bbb85dd --- /dev/null +++ b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md @@ -0,0 +1,14 @@ +# CapyKit - C# Utilities + +Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions. + +Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place! + + +## Getting Started + +This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). + +If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be. + +For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md) diff --git a/Documentation/Help/Home.md b/Documentation/Help/Home.md index 079dbe5..bbb85dd 100644 --- a/Documentation/Help/Home.md +++ b/Documentation/Help/Home.md @@ -1,15 +1,14 @@ # CapyKit - C# Utilities -Version [TODO: Version] was released on [TODO: Date]. +Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions. + +Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place! -## Changes in This Release -

  • [TODO: Add change items here]

+## Getting Started +This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). +If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be. -## See Also - - -#### Other Resources -[7d36447b-0aab-4ce9-b5ed-e60ec5bee103] +For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md) diff --git a/Documentation/Help/N_CapyKit.md b/Documentation/Help/N_CapyKit.md index 92294f1..008918d 100644 --- a/Documentation/Help/N_CapyKit.md +++ b/Documentation/Help/N_CapyKit.md @@ -1,7 +1,7 @@ # CapyKit Namespace -\[Missing <summary> documentation for "N:CapyKit"\] +Core utilities and foundational methods for the CapyKit library. diff --git a/Documentation/Help/N_CapyKit_Attributes.md b/Documentation/Help/N_CapyKit_Attributes.md index b6d67f6..a5a99b2 100644 --- a/Documentation/Help/N_CapyKit_Attributes.md +++ b/Documentation/Help/N_CapyKit_Attributes.md @@ -1,7 +1,7 @@ # CapyKit.Attributes Namespace -\[Missing <summary> documentation for "N:CapyKit.Attributes"\] +Custom attributes for simplifying .NET code behavior. diff --git a/Documentation/Help/N_CapyKit_Enumerations.md b/Documentation/Help/N_CapyKit_Enumerations.md index 7085ef2..84a6217 100644 --- a/Documentation/Help/N_CapyKit_Enumerations.md +++ b/Documentation/Help/N_CapyKit_Enumerations.md @@ -1,7 +1,7 @@ # CapyKit.Enumerations Namespace -\[Missing <summary> documentation for "N:CapyKit.Enumerations"\] +Commonly used enumerations for value comparison and logic. diff --git a/Documentation/Help/N_CapyKit_Extensions.md b/Documentation/Help/N_CapyKit_Extensions.md index d90033f..7c21b7b 100644 --- a/Documentation/Help/N_CapyKit_Extensions.md +++ b/Documentation/Help/N_CapyKit_Extensions.md @@ -1,7 +1,7 @@ # CapyKit.Extensions Namespace -\[Missing <summary> documentation for "N:CapyKit.Extensions"\] +Extension methods for enhancing .NET classes and simplifying operations. diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md index 76e7d1a..c1a84a0 100644 --- a/Documentation/Help/N_CapyKit_Helpers.md +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -1,7 +1,7 @@ # CapyKit.Helpers Namespace -\[Missing <summary> documentation for "N:CapyKit.Helpers"\] +Utility classes for tasks like data manipulation and reflection. diff --git a/Documentation/Help/N_Tests.md b/Documentation/Help/N_Tests.md index ea69e43..144965a 100644 --- a/Documentation/Help/N_Tests.md +++ b/Documentation/Help/N_Tests.md @@ -1,7 +1,7 @@ # Tests Namespace -\[Missing <summary> documentation for "N:Tests"\] +Unit tests ensuring CapyKit functions as expected. diff --git a/Documentation/Help/N_Tests_Helpers.md b/Documentation/Help/N_Tests_Helpers.md index 481f73c..6e2c166 100644 --- a/Documentation/Help/N_Tests_Helpers.md +++ b/Documentation/Help/N_Tests_Helpers.md @@ -1,7 +1,7 @@ # Tests.Helpers Namespace -\[Missing <summary> documentation for "N:Tests.Helpers"\] +Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`. diff --git a/Documentation/Help/R_Project_Documentation.md b/Documentation/Help/R_Project_Documentation.md index 80c8f13..846b040 100644 --- a/Documentation/Help/R_Project_Documentation.md +++ b/Documentation/Help/R_Project_Documentation.md @@ -1,29 +1,31 @@ # Namespaces +Welcome to the official documentation for CapyKit, a powerful collection of C# utilities designed to enhance your .NET projects. Below, you'll find a list of namespaces included in the library, each offering a unique set of tools, extensions, and helpers to streamline your development process. + ## Namespaces - + - + - + - + - + - + - +
CapyKit
Core utilities and foundational methods for the CapyKit library.
CapyKit.Attributes
Custom attributes for simplifying .NET code behavior.
CapyKit.Enumerations
Commonly used enumerations for value comparison and logic.
CapyKit.Extensions
Extension methods for enhancing .NET classes and simplifying operations.
CapyKit.Helpers
Utility classes for tasks like data manipulation and reflection.
Tests
Unit tests ensuring CapyKit functions as expected.
Tests.Helpers
Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`.
\ No newline at end of file diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md index d266c52..3fdff72 100644 --- a/Documentation/Help/_Sidebar.md +++ b/Documentation/Help/_Sidebar.md @@ -1,4 +1,4 @@ -- [CapyKit - C# Utilities](fa7407d1-9116-4ad7-a9ab-ed094685b070.md) +- [CapyKit - C# Utilities](849aa079-3d64-4cf1-966f-44af23c73160.md) - [Namespaces](R_Project_Documentation.md) - [CapyKit Namespace](N_CapyKit.md) - [CapyEventArgs Class](T_CapyKit_CapyEventArgs.md) diff --git a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md deleted file mode 100644 index 079dbe5..0000000 --- a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md +++ /dev/null @@ -1,15 +0,0 @@ -# CapyKit - C# Utilities - -Version [TODO: Version] was released on [TODO: Date]. - - -## Changes in This Release -

  • [TODO: Add change items here]

- - - -## See Also - - -#### Other Resources -[7d36447b-0aab-4ce9-b5ed-e60ec5bee103]