[No Code] Adding Detailed Documentation for the CUI system #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Uploading Documentation onto a clean branch because having 557 Stackedit commits doesn't seem sensible
Uploading Documentation onto a clean branch because having 557 Stackedit commits doesn't seem sensible
Fixed InputField name & added section about Text Selection added notice explaining the default values in the json examples
Improved spelling & fixed capitalization issues added section for Layers in the Basics expanded on Positioning in Bugs-Tips expanded on the imagetype setting for the image component added references to the bugs/error messages in some of the other pages added explanation for hudMenuInput & needsKeyboard fields on Input Component
added note explaining that supplying a skinid of 0 causes client issues
Corrected ordering of all Layer values & added descriptions to Hud & Hud.Menu
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating expandable Documentation for the CUI System & its Components
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.