Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: add documentation for modules in contributing#18597

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
DevelopmentCats wants to merge13 commits intomain
base:main
Choose a base branch
Loading
fromcat/modules-doc

Conversation

DevelopmentCats
Copy link
Contributor

Let me know if this align's with what you were looking for in this modules doc.@matifali

@DevelopmentCatsDevelopmentCats added the docsArea: coder.com/docs labelJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titlefeat: Add Coder Documentation for Contributing docsdocs: Add Coder Documentation for Contributing docsJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titledocs: Add Coder Documentation for Contributing docsdocs: add modules documentation for contributing docsJun 26, 2025
@DevelopmentCatsDevelopmentCats changed the titledocs: add modules documentation for contributing docsdocs: add documentation for modules in contributingJun 26, 2025
@DevelopmentCatsDevelopmentCats marked this pull request as draftJune 26, 2025 02:34
@matifali
Copy link
Member

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:

  • Enable an external ide integration.
  • Enable an externality auth with a service by installing CLI binary ir injecting some env variable
  • Writing some configuration files.
  • Install a VSCode extension?

In these we can also link existing matching module implementations as examples.

DevelopmentCats reacted with thumbs up emoji

@DevelopmentCats
Copy link
ContributorAuthor

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 👌

}
```

####coder_app - User Interface
Copy link
Member

Choose a reason for hiding this comment

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

I suggest adding some screenshots in sections like this!


###External IDE Integration

**Browser-based IDE Pattern**: Install web-based development environment with health monitoring and configuration management.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I have moved it up and reorganized into a more worthy module type list.

Let me know if this vibes with you

Comment on lines 405 to 428
###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.

Copy link
Member

Choose a reason for hiding this comment

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

Can we also link example modules heres?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

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/

DevelopmentCatsand others added6 commitsJune 26, 2025 18:49
…per, Desktop, AI, Integration, and Web-based Tools and remove duplicate explanation from end of doc.
Co-authored-by: Atif Ali <atif@coder.com>
…ced resource links for better clarityaddressed all comments up to commit time aside from unresolved comments awaiting replies
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@bpmctbpmctbpmct left review comments

@matifalimatifalimatifali requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@DevelopmentCatsDevelopmentCats

Labels
docsArea: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@DevelopmentCats@matifali@bpmct

[8]ページ先頭

©2009-2025 Movatter.jp