add plugin developer guide

[0xbbjoker]

No description provided.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/plugin-developer-guide

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[claude]

Claude finished @0xbbjoker's task —— View job

---

Documentation Standards Review

I've completed a comprehensive review of this PR against our Mintlify documentation standards. This is an excellent, well-structured plugin developer guide that follows best practices.

✅ Overall Assessment: APPROVED

This documentation meets all Mintlify standards and provides comprehensive, high-quality guidance for plugin developers.

✅ MDX Syntax & Structure - Excellent

Frontmatter (lines 1-5):

• ✅ Proper YAML frontmatter with required title and description
• ✅ Includes icon: code for better visual consistency
• ✅ No H1 header in content (avoids double header issue)

Mintlify Components:

• ✅ Proper usage of <Note> components (lines 9-11, 229-231, 2544-2551)
• ✅ Proper usage of <Tip> components (lines 151-153)
• ✅ Components are properly formatted and contextually appropriate

Code Blocks:

• ✅ All code blocks have proper language tags (typescript, bash, json, etc.)
• ✅ Code examples are properly formatted and complete
• ✅ Good use of syntax highlighting

✅ Link Validation - Good

Internal Links:

• ✅ Link to /guides/plugin-publishing-guide (line 2529) is valid and exists in navigation
• ✅ Uses proper relative path structure

External Links:

• ✅ Minimal external links, only one reference to npmjs.org in a comment (line 1989)
• ✅ No broken or outdated external links

✅ Content Quality - Excellent

Voice & Style:

• ✅ Consistent second-person voice ("you") throughout
• ✅ Active voice and present tense used appropriately
• ✅ Clear, concise instructions with good examples

Structure & Organization:

• ✅ Comprehensive table of contents (lines 13-31)
• ✅ Logical flow from quick start to advanced topics
• ✅ Good use of progressive disclosure

✅ Navigation & Organization - Perfect

Navigation Integration:

• ✅ Properly added to docs.json under "Guides" group (line 50)
• ✅ Logical placement in navigation hierarchy

📋 Specific Strengths

1. Comprehensive Coverage: Covers all aspects from quick start to advanced patterns
2. Practical Examples: Each concept includes working code examples
3. Best Practices: Emphasizes security, testing, and proper architecture
4. Tool Integration: Shows proper integration with Bun, TypeScript, and testing frameworks
5. Real-world Patterns: Includes actual patterns from existing plugins

🔍 Minor Observations (Optional Improvements)

While the documentation fully meets standards, here are some optional enhancements to consider:

1. Length Management: At 2,708 lines, consider if some sections could be split into separate focused guides
2. Cross-references: Could add more internal links between related sections
3. Visual Breaks: Consider adding more code block titles or section dividers for very long code examples

✅ Recommendation

APPROVE - This documentation is ready for merge. It exemplifies excellent technical writing and comprehensive coverage while strictly adhering to all Mintlify documentation standards.

---