mirror of
https://github.com/wagesj45/CapyKit.git
synced 2025-08-02 09:38:24 -05:00
Documentation Configuration
This commit is contained in:
parent
b0ebf43ae9
commit
a0492aaa0b
15 changed files with 71 additions and 79 deletions
14
Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md
Normal file
14
Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md
Normal file
|
|
@ -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)
|
||||
|
|
@ -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
|
||||
<ul><li><p>[TODO: Add change items here]</p></li></ul>
|
||||
## 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)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CapyKit Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:CapyKit"\]
|
||||
Core utilities and foundational methods for the CapyKit library.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CapyKit.Attributes Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:CapyKit.Attributes"\]
|
||||
Custom attributes for simplifying .NET code behavior.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CapyKit.Enumerations Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:CapyKit.Enumerations"\]
|
||||
Commonly used enumerations for value comparison and logic.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CapyKit.Extensions Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:CapyKit.Extensions"\]
|
||||
Extension methods for enhancing .NET classes and simplifying operations.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# CapyKit.Helpers Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:CapyKit.Helpers"\]
|
||||
Utility classes for tasks like data manipulation and reflection.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Tests Namespace
|
||||
|
||||
|
||||
\[Missing <summary> documentation for "N:Tests"\]
|
||||
Unit tests ensuring CapyKit functions as expected.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="N_CapyKit.md">CapyKit</a></td>
|
||||
<td /></tr>
|
||||
<td>Core utilities and foundational methods for the CapyKit library.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a></td>
|
||||
<td /></tr>
|
||||
<td>Custom attributes for simplifying .NET code behavior.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_CapyKit_Enumerations.md">CapyKit.Enumerations</a></td>
|
||||
<td /></tr>
|
||||
<td>Commonly used enumerations for value comparison and logic.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a></td>
|
||||
<td /></tr>
|
||||
<td>Extension methods for enhancing .NET classes and simplifying operations.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a></td>
|
||||
<td /></tr>
|
||||
<td>Utility classes for tasks like data manipulation and reflection.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_Tests.md">Tests</a></td>
|
||||
<td /></tr>
|
||||
<td>Unit tests ensuring CapyKit functions as expected.</td></tr>
|
||||
<tr>
|
||||
<td><a href="N_Tests_Helpers.md">Tests.Helpers</a></td>
|
||||
<td /></tr>
|
||||
<td>Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`.</td></tr>
|
||||
</table>
|
||||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
# CapyKit - C# Utilities
|
||||
|
||||
Version [TODO: Version] was released on [TODO: Date].
|
||||
|
||||
|
||||
## Changes in This Release
|
||||
<ul><li><p>[TODO: Add change items here]</p></li></ul>
|
||||
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
|
||||
#### Other Resources
|
||||
[7d36447b-0aab-4ce9-b5ed-e60ec5bee103]
|
||||
Loading…
Add table
Add a link
Reference in a new issue