Facepunch
[No Code] Adding Detailed Documentation for the CUI system
Creating expandable Documentation for the CUI System & its Components
This PR has no code changes, it's purely focussed on explaining the API the rust client provides. The documentation is separated into multiple files to allow future PRs to amend & add to the documentation as new features get added.
It has a built-in navigation system to seamlessly transition between topics, and a table of contents to give an overview of what the CUI system has to offer.
I've written this documentation for a few reasons, the most important being that new plugin/mod developers often ask for any guides/documentation when starting out with the CUI system. Therefore, I wrote the documentation in a way that covers the basics while also educating readers about the details of how each component works.
Another reason for writing it is also the idea that it can get expanded directly by future PRs, allowing even experienced devs to quickly understand new features & changes. This is also the reason the documentation is part of the Repo, as keeping it separated like on a wiki would create a lot of extra work & friction.
Lastly, while I wrote it and plan to make additions to it as things evolve, it's meant to be something that can be amended by anyone, to ensure it always stay up to date.
Upcoming additions
I plan to make additions for all of my pending PRs in the following order. They will be put on a separate branch until this PR gets merged, but will be included in their respective PRs before they get merged.
- [x] #54
- [ ] #55
- [ ] #56
- [ ] #47
