Documentation overhaul & add Bundle.ModalButton#2
Open
bryanchriswhite wants to merge 8 commits intozealotrunner:masterfrom
Open
Documentation overhaul & add Bundle.ModalButton#2bryanchriswhite wants to merge 8 commits intozealotrunner:masterfrom
Bundle.ModalButton#2bryanchriswhite wants to merge 8 commits intozealotrunner:masterfrom
Conversation
|
Whatever the state of this PR, it should be merged. Contains useful info that exists nowhere else... Thanks for tat! |
|
@bryanchriswhite Great work with creating documentation. I have used this PR in my rewrite of fancy setting https://github.com/bartekplus/fancier-settings, I hope you are ok with that(if not please let me know) |
This file contains hidden or 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
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.
As the original github user account/repo seems to have disappeared, and the wiki/documentation along with it, I've gone through the codebase to try to get an understanding of how things work, documenting my findings as I go.
The documentation here isn't quite done; there are a few WIP sections but I figured I might as well open this PR because it's definitely better than no documentation.
This PR also includes the addition of a new setting type: the
ModalButton, which renders a button that triggers a modal which can contain nested settings. See the docs for more info.Lastly, I reformatted the javascript to use 2 spaces instead of 4, removed all unnecessary quotes from javascript object keys, and replaced double quotes with single quotes. There may be a few other curious formatting changes due to the way I have webstorm configured; If you don't want these changes you can just revert 178b7f1.