Generating technical documentation from C# code using DocFX and deploying it to GitHub Pages. It includes setting up DocFX, customizing the documentation layout, and configuring the GitHub repository for hosting. The goal is to provide a professional and accessible documentation site that reflects the project's codebase.
Take into consideration to use this GitHub Notes Highlight:
https://github.com/orgs/community/discussions/16925
And the output should be something similar to this (image below):
https://learn.microsoft.com/en-us/cli/azure/get-started-tutorial-3-use-variables?tabs=bash
Some of the consideration:
- Only document public methods that will be used by consumers
- Silent mode and all its methods are very important
- Creating one website for each framework or toolkit or creating one website for all and subsites for each one under the main website.
Generating technical documentation from C# code using DocFX and deploying it to GitHub Pages. It includes setting up DocFX, customizing the documentation layout, and configuring the GitHub repository for hosting. The goal is to provide a professional and accessible documentation site that reflects the project's codebase.
Take into consideration to use this GitHub Notes Highlight:
https://github.com/orgs/community/discussions/16925
And the output should be something similar to this (image below):
https://learn.microsoft.com/en-us/cli/azure/get-started-tutorial-3-use-variables?tabs=bash
Some of the consideration: