teal icon indicating copy to clipboard operation
teal copied to clipboard

Improve documentation on creating custom teal module

Open donyunardi opened this issue 4 months ago • 2 comments

Summary

We currently have an article on how to create custom teal module here. However, I’m still receiving feedback from internal users about the difficulty in understanding the content of this vignette.

While we provide a full code example on how to write a teal module, there isn’t much context explaining what the code does, leaving users to figure it out themselves. Another common issue I’ve heard is related to troubleshooting custom teal modules. While it’s easy to do this with browser(), explicitly mentioning it in the documentation would be helpful.

Let’s improve this documentation by providing a detailed step-by-step guide on building a teal module. We’ll focus on adding explanations alongside the code and include guidance on troubleshooting teal modules.

Personally, I really like the flow of explanation this topic in our youtube video. It would be great if we follow the same explanation style.

donyunardi avatar Sep 27 '24 18:09 donyunardi