diff --git a/docs/api/icon.md b/docs/api/icon.md index 328823f..07824ac 100644 --- a/docs/api/icon.md +++ b/docs/api/icon.md @@ -66,7 +66,7 @@ Associates the given name to the icon which enables it to be retrieved with ``Ic ```lua icon:setProperty(propertyName, value) ``` -An alternative way of doing ``zone[propertyName] = value``. This enables the easy-configuration of icon properties within chained methods. +An alternative way of doing ``icon[propertyName] = value``. This enables the easy-configuration of icon properties within chained methods. ---- #### select @@ -92,6 +92,8 @@ icon:notify(clearNoticeEvent) ``` Prompts a notice bubble which accumulates the further it is prompted. If the icon belongs to a dropdown or menu, then the notice will appear on the parent icon when the parent icon is deselected. +`clearNoticeEvent` should be a [RBXScriptSignal](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal). + ---- #### clearNotices {chainable} diff --git a/docs/contributing.md b/docs/contributing.md index 85a36db..1297fcc 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -6,14 +6,19 @@ [open an issue]: https://github.com/1ForeverHD/TopbarPlus/issues ## Bug Reports +<<<<<<< HEAD - To submit a bug report, [open an issue] with label ``Type: Bug`` or create a response at the [discussion thread]. - Ensure your report includes a detailed explanation of the problem with any relevant images, videos, etc (such as console errors). +======= +- To submit a bug report, [open an issue] or create a response at the [discussion thread]. +- Ensure your report includes a detailed explanation of the problem with any relavent images, videos, etc (such as console errors). +>>>>>>> development - Make sure to include a link to a stipped-down uncopylocked Roblox place which reproduces the bug. ## Questions and Feedback - Be sure to check out the documentation and [resources] first before asking a question. - We recommend submitting all questions and feedback to the [discussion thread]. -- You can also [open an issue] with label ``Type: Question``. +- You can also [open an issue]. ## Submitting a resource (video tutorial, port, etc) - Fancy making a tutorial or resource for TopbarPlus? Feel free to get in touch and we can provide tips, best practices, etc. @@ -22,7 +27,7 @@ ## Suggestions and Code - TopbarPlus is completely free and open source; any suggestions and code contributions are greatly appreciated! -- To make a suggestion, [open an issue] with label ``Type: Enhancement`` or create a response at the [discussion thread]. +- To make a suggestion, [open an issue] or create a response at the [discussion thread]. - Please open a suggestion before beginning a code contribution to ensure it's discussed through fully (we wouldn't want to waste your time!). - Some tools you'll find useful when working on this project: - [Rojo](https://rojo.space/docs/) diff --git a/docs/resources.md b/docs/resources.md index 54a6c0a..9079dd8 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -4,7 +4,8 @@ - [Discussion](https://devforum.roblox.com/t/topbarplus-v2-construct-dynamic-and-intuitive-topbar-icons/1017485) - [Repository](https://github.com/1ForeverHD/TopbarPlus) - [Roblox-TS Port](https://github.com/grilme99/TopbarPlus) by [grilme99](https://twitter.com/grilme99) +- [YouTube Video](https://youtu.be/c_emUAWTRKg) by [Inctus](https://www.youtube.com/c/Inctus) ------------------------------------- -If you would like to submit a resource (such as a video tutorial, port, etc), please see [contributing](https://1foreverhd.github.io/TopbarPlus/contributing/). \ No newline at end of file +If you would like to submit a resource (such as a video tutorial, port, etc), please see [contributing](https://1foreverhd.github.io/TopbarPlus/contributing/).