Skip to content

docs: community README for install, develop, and contribute - #1

Draft
tomymaritano wants to merge 1 commit into
mainfrom
cursor/improve-readme-ed1c
Draft

docs: community README for install, develop, and contribute#1
tomymaritano wants to merge 1 commit into
mainfrom
cursor/improve-readme-ed1c

Conversation

@tomymaritano

Copy link
Copy Markdown
Contributor

Expand the plugin README so community can install, develop, and contribute.

  • Describes what the plugin does from README.md, manifest.json, and src/index.js only (insert mermaid fence via menu/command; preview rendering stays in the app)
  • Documents install as dripnex/plugin-mermaid / dripnex-plugin install
  • Documents existing npm run build and npm run pack scripts
  • Adds a short fork/PR contribute section

Docs-only. Draft PR; do not merge.

Open in Web Open in Cursor 

Document what the plugin inserts, community install, npm scripts, and a short PR workflow from the existing source and manifest.

Co-authored-by:  Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants