Skip to content

docs: update plugin upload and add Xquik example - #2

Open
kriptoburak wants to merge 3 commits into
KPZ231:masterfrom
kriptoburak:codex/xquik-plugin-docs
Open

docs: update plugin upload and add Xquik example#2
kriptoburak wants to merge 3 commits into
KPZ231:masterfrom
kriptoburak:codex/xquik-plugin-docs

Conversation

@kriptoburak

@kriptoburak kriptoburak commented Jul 9, 2026

Copy link
Copy Markdown

Summary:

  • Documents the current multipart POST /api/plugins/upload workflow and returned identifiers.
  • Adds the missing post widget capability names from the plugin config.
  • Adds a sandbox-safe Xquik dashboard widget example for social publishing source review.
  • Fixes a pre-existing plugin-authoring defect: type-only SDK imports no longer emit forbidden runtime require calls.
  • Corrects the manifest validation description to match the Zod schema.

Validation:

  • git diff --check
  • TypeScript transpilation assertion confirms the documented type imports emit no require call.
  • CodeRabbit pre-merge checks passed; its MD040 request is fixed and resolved.
  • Full npm run lint, npm test, and npm run build were run. They remain blocked by unrelated baseline failures: a React purity violation, missing generated Prisma client, storage-test environment setup, and an existing language-validation test failure.

Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

Summary by CodeRabbit

  • Documentation
    • Updated the plugin submission guide with the multipart upload workflow and required submission details.
    • Clarified the review status and information returned after uploading a plugin version.
    • Added widget-related capabilities and an example dashboard sidebar widget.
    • Expanded current limitations and manifest validation guidance.
    • Improved Quickstart and developer examples with clearer type-import conventions.

@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

@kriptoburak is attempting to deploy a commit to the kpz231's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation in docs/plugins.md updates the plugin submission workflow to use multipart POST /api/plugins/upload, documents its fields and response, adds widget capabilities, and introduces a dashboard sidebar widget example using KV storage.

Changes

Plugin upload and widget documentation

Layer / File(s) Summary
Multipart upload API flow
docs/plugins.md
Submit, Quickstart, and limitations sections document POST /api/plugins/upload, its multipart fields, the { pluginId, versionId } response, and clarified permission validation. Example imports now use import type.
Widget capabilities and example
docs/plugins.md
Adds widgets:post:composer:sidebar and widgets:post:card:actions, plus a DASHBOARD_SIDEBAR example that reads last-xquik-sync from KV storage.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main docs changes: plugin upload workflow updates and the new Xquik example.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/plugins.md`:
- Around line 857-860: The fenced request example in the plugin upload
documentation is missing a language tag, which triggers MD040. Update the fenced
block around the POST /api/plugins/upload example in docs/plugins.md to use an
http label so the request is easier to scan and the markdown linter passes.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bd98acc7-b230-4be1-b1fb-1ad1338008f2

📥 Commits

Reviewing files that changed from the base of the PR and between 5282721 and bf58111.

📒 Files selected for processing (1)
  • docs/plugins.md

Comment thread docs/plugins.md
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.

1 participant