Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plugins contributions documentation #97

Merged
merged 3 commits into from
Feb 27, 2023

Conversation

AJRubenstein
Copy link
Contributor

added context for "plugins" to hopefully mitigate confusion at top of page

added elaboration to the "basicPluginBuilder" example above to make really clear

added the word binding to plugin with a few of the headers - I can see this being unnecessary at this point

attempted to elaborate the "creating a plugin binding: the hard way" section to the best of my knowledge, I suspect this is not entirely correct. I've added some more specific and clear examples of some of the things being mentioned, as well as links to appropriate resources that will aid in providing the correct arguments.

also added link to "Control Surfaces" in the control binding section for more relevant resources when coding a binding

added a little more text to the Example Plugin section, trying to make it a bit easier to follow

added context for "plugins" to hopefully mitigate confusion at top of page

added elaboration to the "basicPluginBuilder" example above to make really clear

added the word binding to plugin with a few of the headers - I can see this being unnecessary at this point 

attempted to elaborate the "creating a plugin binding: the hard way" section to the best of my knowledge, I suspect this is not entirely correct. I've added some more specific and clear examples of some of the things being mentioned, as well as links to appropriate resources that will aid in providing the correct arguments.

also added link to "Control Surfaces" in the control binding section for more relevant resources when coding a binding

added a little more text to the Example Plugin section, trying to make it a bit easier to follow
Copy link
Owner

@MaddyGuthridge MaddyGuthridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking pretty good, but there are a few improvements that I'd like to see before it gets merged. Thanks for your work so far!

docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
docs/contributing/plugins/README.md Outdated Show resolved Hide resolved
@MaddyGuthridge MaddyGuthridge changed the title Update README.md Update plugins contributions documentation Feb 15, 2023
Copy link
Owner

@MaddyGuthridge MaddyGuthridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed all the issues! Thanks so much for your contributions!

@MaddyGuthridge MaddyGuthridge merged commit 3f500fd into MaddyGuthridge:main Feb 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants