Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request integrates the Docus documentation plugin into the system, significantly enhancing capabilities for documentation generation and review. It introduces dedicated skills for creating comprehensive Docus sites with features like search, dark mode, and AI integration, as well as a skill for evaluating documentation quality. The changes ensure seamless integration and discoverability of Docus within the platform. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
6 issues found across 16 files
Confidence score: 4/5
- This PR is likely safe to merge, with risk concentrated in documentation rendering rather than runtime behavior; issues are moderate (4–5/10) and highly confident.
- Most severe impact is in
plugins/docus/.agents/skills/create-docs/references/templates.md, where nested triple-backtick fences break parsing and cause template examples to render incorrectly for readers. plugins/docus/.agents/skills/create-docs/SKILL.mdhas an npm-only workspace command under an npm/yarn monorepo example, which can mislead Yarn users and make copied guidance fail.- Pay close attention to
plugins/docus/.agents/skills/create-docs/references/templates.md,plugins/docus/.agents/skills/create-docs/SKILL.md,plugins/docus/.agents/skills/create-docs/references/mdc-components.md,plugins/docus/.agents/skills/review-docs/references/clarity-checks.md,plugins/docus/.agents/skills/create-docs/references/writing-guide.md- malformed nested fences and package-manager mismatch can degrade docs usability.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="plugins/docus/.agents/skills/create-docs/references/templates.md">
<violation number="1" location="plugins/docus/.agents/skills/create-docs/references/templates.md:275">
P2: Nested triple-backtick blocks inside a ` ```markdown ` example break the fence parsing, so these templates won’t render as intended. Use a different outer fence delimiter (e.g., four backticks) or switch inner fences to `~~~`.</violation>
</file>
<file name="plugins/docus/.agents/skills/create-docs/references/mdc-components.md">
<violation number="1" location="plugins/docus/.agents/skills/create-docs/references/mdc-components.md:102">
P2: This example nests triple-backtick fences inside a triple-backtick block, which breaks Markdown rendering of the snippet.</violation>
<violation number="2" location="plugins/docus/.agents/skills/create-docs/references/mdc-components.md:133">
P2: The code-group sample uses nested triple-backtick fences, so the outer Markdown code block is prematurely closed.</violation>
</file>
<file name="plugins/docus/.agents/skills/review-docs/references/clarity-checks.md">
<violation number="1" location="plugins/docus/.agents/skills/review-docs/references/clarity-checks.md:72">
P2: The nested code-fence example is malformed: unescaped inner triple backticks terminate the outer `markdown` fence early, so the docs snippet won’t render correctly.</violation>
</file>
<file name="plugins/docus/.agents/skills/create-docs/SKILL.md">
<violation number="1" location="plugins/docus/.agents/skills/create-docs/SKILL.md:245">
P2: The "npm/yarn Monorepo" example uses an npm-only workspace command, which will break for Yarn users. Split this into separate npm and Yarn examples (or make the heading npm-only) so generated guidance is executable.
(Based on your team's feedback about not suggesting local edits for skills.sh-managed SKILL.md files.) [FEEDBACK_USED]</violation>
</file>
<file name="plugins/docus/.agents/skills/create-docs/references/writing-guide.md">
<violation number="1" location="plugins/docus/.agents/skills/create-docs/references/writing-guide.md:86">
P2: The nested code-fence example is malformed: a 3-backtick outer fence cannot contain inner 3-backtick fences, so the rendered example breaks. Use a longer outer fence (for example, 4 backticks) for the `markdown` wrapper.</violation>
</file>
Architecture diagram
sequenceDiagram
participant User
participant C as Claude / Plugin Host
participant MP as Marketplace Config
participant DS as Docus Skills (Agent)
participant FS as Local Workspace (FS)
participant MCP as Docus MCP (Remote)
Note over User, MCP: Plugin Installation & Initialization
User->>C: /plugin install docus@pleaseai
C->>MP: NEW: Lookup "docus" entry
MP-->>C: Return source path & MCP URL
C->>C: Initialize skills (create-docs, review-docs)
C->>MCP: NEW: Connect to https://docus.dev/mcp
Note over User, FS: NEW: Documentation Creation Flow (create-docs)
User->>C: "Create documentation for this project"
C->>DS: Trigger create-docs skill
DS->>FS: Analyze project (README, package.json, Lockfiles)
FS-->>DS: Project metadata (PM, monorepo status)
DS->>DS: Select Template (Standard vs i18n)
DS->>FS: NEW: Initialize /docs or /apps/docs
DS->>FS: NEW: Write content/ (.md), .navigation.yml, & nuxt.config.ts
DS-->>User: Creation summary & next steps
Note over User, FS: NEW: Documentation Review Flow (review-docs)
User->>C: "Review my documentation quality"
C->>DS: Trigger review-docs skill
DS->>FS: Scan content/ directory
FS-->>DS: Markdown & MDC files
DS->>DS: Technical Validation (MDC prefix checks, SEO, Frontmatter)
alt Technical errors found
DS-->>User: Report Critical Issues (e.g., missing 'u-' prefix)
else Content optimization
DS-->>User: Report Important/Nice-to-have SEO & Clarity suggestions
end
Note over C, MCP: MCP Context Loop
opt Complex Docus query
C->>MCP: Query Docus tools/resources
MCP-->>C: Return Docus schema/context
end
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
There was a problem hiding this comment.
Code Review
This pull request introduces a new 'docus' plugin to the marketplace, designed to facilitate the creation and review of documentation sites built with Nuxt and Markdown. The plugin includes two primary skills: create-docs for generating Docus-based documentation, and review-docs for assessing documentation quality, clarity, SEO, and technical correctness. The changes also update the README.md with installation instructions and configure the release process for the new plugin.
Add Docus documentation plugin with: - create-docs and review-docs skills (from nuxt-content/docus via skills.sh) - Docus MCP server (https://docus.dev/mcp) - Marketplace, release-please, and README entries
daeff38 to
5a81a72
Compare
Summary
create-docsandreview-docsskills installed fromnuxt-content/docusviaskills.shhttps://docus.dev/mcp)Test plan
create-docsskill loads and is functionalreview-docsskill loads and is functionalhttps://docus.dev/mcpSummary by cubic
Adds the
docusplugin to the marketplace withcreate-docsandreview-docsskills for building and auditing Docus/Nuxt Content docs. Sets up the MCP server and release automation, and updates the marketplace and README with install instructions.plugins/docuswith.claude-plugin/plugin.json(MCP server athttps://docus.dev/mcp) and skills directory.create-docsandreview-docsskills with references, templates, and a review report template..claude-plugin/marketplace.jsonand README with install command/plugin install docus@pleaseai.release-please-config.jsonto versionplugins/docusand addedskills-lock.jsonto pin skill sources.Written for commit 5a81a72. Summary will update on new commits.