docs: add documentation for modules in contributing #18597
Conversation
|
Can you add a diagram describing how a module fits into Cider architecture? Also I would suggest being lean on the module usage section i.e. example uses, and more detailed on how to write the module and what is the significance of each type of resource an author can add to the module. What are those sources provided. Here we can also consider examples like what will be needed to write a module to:
In these we can also link existing matching module implementations as examples. |
|
Okay I had those exact examples in my registry version so I'll clean up and add these to the contributing doc and take into account the rest of your points as well 👌 |
docs/about/contributing/modules.md
Outdated
| } | ||
| ``` | ||
|
|
||
| #### coder_app - User Interface |
There was a problem hiding this comment.
I suggest adding some screenshots in sections like this!
docs/about/contributing/modules.md
Outdated
|
|
||
| ### External IDE Integration | ||
|
|
||
| **Browser-based IDE Pattern**: Install web-based development environment with health monitoring and configuration management. |
There was a problem hiding this comment.
Ah I see! You did it down here. I suggest bringing this up more, add links to registry, and remove "Pattern" from the end of each Section.
There was a problem hiding this comment.
I have moved it up and reorganized into a more worthy module type list.
Let me know if this vibes with you
docs/about/contributing/modules.md
Outdated
| ### External IDE Integration | ||
|
|
||
| **Browser-based IDE Pattern**: Install web-based development environment with health monitoring and configuration management. | ||
|
|
||
| **Desktop IDE Pattern**: Provide protocol-based integration for native applications with backend service management. | ||
|
|
||
| **Editor Extension Pattern**: Configure existing editors with workspace-specific settings and extensions. | ||
|
|
||
| ### Authentication and Secrets | ||
|
|
||
| **OAuth Integration Pattern**: Handle external authentication flows with token management and service configuration. | ||
|
|
||
| **API Key Management Pattern**: Securely distribute credentials and configure authenticated tools. | ||
|
|
||
| **Certificate Management Pattern**: Handle SSL certificates and secure communication setup. | ||
|
|
||
| ### Development Environment Setup | ||
|
|
||
| **Language Runtime Pattern**: Install and configure programming language environments with package managers. | ||
|
|
||
| **Database Service Pattern**: Deploy and configure database services with connection management. | ||
|
|
||
| **Configuration Management Pattern**: Apply dotfiles, settings, and workspace personalization. | ||
|
|
There was a problem hiding this comment.
Can we also link example modules heres?
There was a problem hiding this comment.
Moved module type list up and included module groups with tag links for registry with tag search per-propogated.
Let me know if this vibes with what you were thinking/
…per, Desktop, AI, Integration, and Web-based Tools and remove duplicate explanation from end of doc.
Co-authored-by: Atif Ali <[email protected]>
…ced resource links for better clarity addressed all comments up to commit time aside from unresolved comments awaiting replies
Let me know if this align's with what you were looking for in this modules doc. @matifali