mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-12-21 04:42:29 -06:00
Documentation Configuration
This commit is contained in:
parent
b0ebf43ae9
commit
a0492aaa0b
15 changed files with 71 additions and 79 deletions
|
|
@ -2,54 +2,36 @@
|
|||
<topic id="849aa079-3d64-4cf1-966f-44af23c73160" revisionNumber="1">
|
||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<introduction>
|
||||
<para>This is a sample conceptual topic. You can use this as a starting point for adding more conceptual
|
||||
content to your help project.</para>
|
||||
<para>
|
||||
Welcome to the official documentation for <bold>CapyKit</bold> – your go-to utility kit for boosting productivity in any <bold>.NET</bold> project.
|
||||
Originally born out of the <em>HappyCapy</em> project, <bold>CapyKit</bold> is now fully open for the community,
|
||||
offering a wide array of C# utilities and extensions.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Whether you're looking to integrate some handy extensions into your existing project or you're exploring what
|
||||
<bold>CapyKit</bold> can do for your next venture, you've come to the right place!
|
||||
</para>
|
||||
</introduction>
|
||||
|
||||
<section>
|
||||
<title>Getting Started</title>
|
||||
<content>
|
||||
<para>To get started, add a documentation source to the project (a Visual Studio solution, project, or
|
||||
assembly and XML comments file). See the <legacyBold>Getting Started</legacyBold> topics in the Sandcastle Help
|
||||
File Builder's help file for more information. The following default items are included in this project:</para>
|
||||
<para>
|
||||
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).
|
||||
</para>
|
||||
|
||||
<list class="bullet">
|
||||
<listItem>
|
||||
<para><localUri>ContentLayout.content</localUri> - Use the content layout file to manage the
|
||||
conceptual content in the project and define its layout in the table of contents.</para>
|
||||
</listItem>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<listItem>
|
||||
<para>The <localUri>.\media</localUri> folder - Place images in this folder that you will reference
|
||||
from conceptual content using <codeInline>medialLink</codeInline> or <codeInline>mediaLinkInline</codeInline>
|
||||
elements. If you will not have any images in the file, you may remove this folder.</para>
|
||||
</listItem>
|
||||
|
||||
<listItem>
|
||||
<para>The <localUri>.\icons</localUri> 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 <ui>Transform Args</ui> project properties page by removing or changing the filename in the
|
||||
<codeInline>logoFile</codeInline> transform argument. Note that unlike images referenced from conceptual topics,
|
||||
the logo file should have its <legacyBold>BuildAction</legacyBold> property set to <codeInline>Content</codeInline>.</para>
|
||||
</listItem>
|
||||
|
||||
<listItem>
|
||||
<para>The <localUri>.\Content</localUri> 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.</para>
|
||||
</listItem>
|
||||
</list>
|
||||
|
||||
<para>See the <legacyBold>Conceptual Content</legacyBold> topics in the Sandcastle Help File Builder's
|
||||
help file for more information. See the <legacyBold> Sandcastle MAML Guide</legacyBold> for details on Microsoft
|
||||
Assistance Markup Language (MAML) which is used to create these topics.</para>
|
||||
<para>
|
||||
For a complete overview of the automatically generated documentation, start by exploring the
|
||||
[API and Utilities Reference](R_Project_Documentation.md)
|
||||
</para>
|
||||
</content>
|
||||
</section>
|
||||
|
||||
<relatedTopics>
|
||||
<link xlink:href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" />
|
||||
</relatedTopics>
|
||||
</developerConceptualDocument>
|
||||
</topic>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Topics>
|
||||
<Topic id="fa7407d1-9116-4ad7-a9ab-ed094685b070" visible="True" isDefault="true" isSelected="true" title="CapyKit - C# Utilities">
|
||||
<Topic id="849aa079-3d64-4cf1-966f-44af23c73160" visible="True" isDefault="true" isSelected="true" apiParentMode="InsertAfter" title="CapyKit - C# Utilities">
|
||||
<HelpKeywords>
|
||||
<HelpKeyword index="K" term="Welcome" />
|
||||
</HelpKeywords>
|
||||
|
|
|
|||
|
|
@ -62,6 +62,16 @@
|
|||
<IncludeFavorites>False</IncludeFavorites>
|
||||
<WebsiteSdkLinkType>Msdn</WebsiteSdkLinkType>
|
||||
<AppendMarkdownFileExtensionsToUrls>True</AppendMarkdownFileExtensionsToUrls>
|
||||
<ProjectSummary>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.</ProjectSummary>
|
||||
<NamespaceSummaries>
|
||||
<NamespaceSummaryItem name="(global)" isDocumented="False" xmlns="" />
|
||||
<NamespaceSummaryItem name="CapyKit" isDocumented="True" xmlns="">Core utilities and foundational methods for the CapyKit library.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="CapyKit.Attributes" isDocumented="True" xmlns="">Custom attributes for simplifying .NET code behavior.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="CapyKit.Enumerations" isDocumented="True" xmlns="">Commonly used enumerations for value comparison and logic.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="CapyKit.Extensions" isDocumented="True" xmlns="">Extension methods for enhancing .NET classes and simplifying operations.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="CapyKit.Helpers" isDocumented="True" xmlns="">Utility classes for tasks like data manipulation and reflection.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="Tests" isDocumented="True" xmlns="">Unit tests ensuring CapyKit functions as expected.</NamespaceSummaryItem>
|
||||
<NamespaceSummaryItem name="Tests.Helpers" isDocumented="True" xmlns="">Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`.</NamespaceSummaryItem></NamespaceSummaries>
|
||||
</PropertyGroup>
|
||||
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
|
||||
the build. The others are optional common platform types that may appear. -->
|
||||
|
|
|
|||
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…
Reference in a new issue