#4742 Document use of doxygen for doc creation

Author: rockfordlhotka

Source/docs/contributors.md

@@ -0,0 +1,39 @@
+# CSLA .NET {#mainpage}
+
+![CSLA logo](https://raw.github.com/MarimerLLC/csla/main/Support/Logos/csla%20win8_compact_s.png)
+
+CSLA .NET is a home for your business logic in any .NET application.
+
+## Basic information
+
+Getting started:
+
+* [What is CSLA .NET?](https://github.com/MarimerLLC/csla/blob/main/docs/What-is-CSLA-.NET.md)
+* [CSLA .NET overview whitepaper](https://github.com/MarimerLLC/csla/raw/main/Support/magenic-white-paper-overview-of-csla.pdf)
+
+For more information, please see:
+
+* [CSLA .NET home page](http://www.cslanet.com)
+* [CSLA .NET GitHub repo](https://github.com/MarimerLLC/csla)
+* [Announcements](https://github.com/MarimerLLC/csla/discussions?discussions_q=category%3AAnnouncements)
+* [CSLA .NET Discussions](https://github.com/MarimerLLC/csla/discussions)
+* [Sponsor CSLA .NET](https://github.com/sponsors/rockfordlhotka)
+
+## Social Media
+
+* [Bluesky](https://bsky.app/profile/cslanet.bsky.social)
+* [Mastodon](https://dotnet.social/@cslanet)
+* [LinkedIn](https://www.linkedin.com/company/91103195/)
+* [Facebook](https://www.facebook.com/groups/cslanet/)
+
+## Contributors
+
+* [Contributors in GitHub](https://github.com/MarimerLLC/csla/graphs/contributors)
+* [More comprehensive list](https://www.openhub.net/p/cslanet/contributors/summary) including from before our use of GitHub
+
+## External links
+
+* [Wikipedia page](http://en.wikipedia.org/wiki/CSLA_.NET)
+* [Open Hub](https://www.openhub.net/p/cslanet)
+* [StackOverflow](http://stackoverflow.com/tags/csla/info)
+* [Rockford Lhotka blog](https://blog.lhotka.net)

Source/docs/docs-readme.md

@@ -18,9 +18,8 @@ INPUT = csla/Source/Csla \
         csla/Source/Csla.Xaml.Maui \
         csla/Source/Csla.Xaml.Shared \
         csla/Source/Csla.Xaml.Wpf \
-        csla/docs \
-        csla/Source/docs/contributors.md
-USE_MDFILE_AS_MAINPAGE = csla/docs/readme.md
+        csla/Source/docs/docs-readme.md
+USE_MDFILE_AS_MAINPAGE = csla/Source/docs/docs-readme.md
 OUTPUT_DIRECTORY = output
 EXTRACT_ALL = YES
 RECURSIVE = YES

Source/docs/doxyfile

@@ -1,36 +1,41 @@
-# CSLA .NET {#mainpage}
+# Doxygen Documentation Generation
 
-![CSLA logo](https://raw.github.com/MarimerLLC/csla/main/Support/Logos/csla%20win8_compact_s.png)
+This document provides an overview of how to generate documentation using Doxygen for the CSLA .NET project.
 
-CSLA .NET is a home for your business logic in any .NET application.
+## Prerequisites
 
-> [!note] 
-> Contributors!!!
+Before generating the documentation, ensure you have the following installed:
 
-[Contributors](#contributors)
- 
-For more information, please see:
+- [Doxygen](https://www.doxygen.nl/)
+- Clone the [CSLA .NET repository](https://github.com/MarimerLLC/csla)
 
-* [CSLA .NET home page](https://cslanet.com)
-* [CSLA .NET GitHub repo](https://github.com/MarimerLLC/csla)
-* [CSLA .NET Discussions](https://github.com/MarimerLLC/csla/discussions)
+## Generating Documentation
 
-## Basic information
+To generate the documentation, run the following command _one level above_ the root directory of the project:
 
-* [What is CSLA .NET?](What-is-CSLA-.NET.md)
-* [Sponsor CSLA .NET](https://github.com/sponsors/rockfordlhotka)
-* [Testimonials and Usage](Testimonials-and-Usage.md)
-* [CSLA .NET overview whitepaper](https://github.com/MarimerLLC/csla/raw/master/Support/magenic-white-paper-overview-of-csla.pdf)
+```bash
+doxygen -q csla/Source/docs/doxyfile
+```
 
-## External links
+This will generate the documentation based on the configuration specified in the `doxyfile`. The output will be placed in the directory specified by the `OUTPUT_DIRECTORY` setting in the `doxyfile`. The default is an `output` directory at the level where you ran the command.
 
-* [Rockford Lhotka home page](https://lhotka.net)
-* [Rockford Lhotka blog](https://blog.lhotka.net)
-* [Jonny Bekkum blog](https://jonnybekkum.wordpress.com/)
-* [Wikipedia page](http://en.wikipedia.org/wiki/CSLA_.NET)
-* [Open Hub](https://www.openhub.net/p/cslanet)
-* [LinkedIn](https://www.linkedin.com/groups/99453/)
-* Facebook [Group](https://www.facebook.com/groups/cslanet/) | [Page](https://www.facebook.com/CslaNet)
-* [StackOverflow](http://stackoverflow.com/tags/csla/info)
-* [Bluesky](https://bsky.app/profile/cslanet.bsky.social)
-* [Fediverse/Mastodon](https://dotnet.social/@cslanet)
+```text
+csla/
+output/
+```
+
+The generated documentation will include HTML files that you can open in a web browser to view the API documentation.
+
+## Viewing the Documentation
+
+To view the generated documentation, open the `index.html` file located in the `output/html` directory in your web browser.
+
+```text
+output/html/index.html
+```
+
+This will display the main page of the generated documentation, where you can navigate through the various classes, files, and namespaces documented by Doxygen.
+
+## Landing Page Content
+
+The `docs-readme.md` file serves as the landing page for the generated documentation. It provides an overview of the project, instructions for generating the documentation, and guidance on how to navigate and use the generated API documentation. This file is written in Markdown and is converted to HTML by Doxygen to create the main page of the documentation.

Source/docs/readme.md

@@ -41,6 +41,6 @@ Here are some resources to help you get started with CSLA .NET:
 
 ## Contributing
 
-We welcome contributions to CSLA .NET. 
+We welcome contributions to CSLA .NET.
 
 * Please read the [contribution guidelines](https://github.com/MarimerLLC/csla/blob/main/.github/CONTRIBUTING.md) for more information.