docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

docs: improve README for community contribution - #591

Open
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778
Open

docs: improve README for community contribution#591
tomymaritano wants to merge 2 commits into
developfrom
cursor/readme-community-contribution-1778

Conversation

@tomymaritano

@tomymaritanotomymaritano commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the root README so a new contributor can see what this repo is, how to run it, and how to contribute — without invented product claims.

  • What this is: desktop/product monorepo; Markdown files on disk; offline default; open-core as documented in LICENSE (MIT packages vs proprietary desktop/licensing).
  • How to run: real scripts from package.json (pnpm install, pnpm dev, desktop-only filter). Notes that pnpm dev is Turbo and also starts other workspace dev scripts, and that pnpm test excludes storage-sqlite.
  • How to contribute: PRs against develop; conventional commits; plugins/themes live in satellite dripnex/plugin-* and dripnex/theme-* repos, not this monorepo.

Also updates CONTRIBUTING.md (it still pointed at the old readide clone URL and told people to PR main) and makes .github/CONTRIBUTING.md a short pointer to the root guide.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Related Issues

None.

Checklist

  • I've read CONTRIBUTING.md
  • Tests pass locally (pnpm test) — docs-only; not run
  • Build succeeds (pnpm build) — docs-only; not run
  • PR targets develop branch (not main)

Screenshots

Not applicable (markdown only).

Open in WebOpen in Cursor

@cursoragent@tomymaritano
docs: improve README for community contribution
d064959
Rewrite the root README around what this repo is, how to run it, and how to contribute. Point plugin and theme work at satellite dripnex/plugin-* and dripnex/theme-* repos. Align CONTRIBUTING with develop-based PRs and the current clone URL.
Co-authored-by: Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitaiBot commented Aug 24, 2026•
edited
Loading

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2c8b93e7-49a0-4e3c-9e82-16bc44ef3083

📥 Commits

Reviewing files that changed from the base of the PR and between 0d31267 and e7be690.

📒 Files selected for processing (3)
  • .github/CONTRIBUTING.md
  • CONTRIBUTING.md
  • README.md

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.

@tomymaritano
tomymaritano marked this pull request as ready for review August 24, 2026 17:19
@github-actions
github-actionsBot enabled auto-merge (squash) August 24, 2026 17:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cisize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tomymaritano@cursoragent