Back to all reviewers

Document configuration alternatives

prisma/prisma
Based on 2 comments
Markdown

When documenting configuration setup, provide multiple formats and approaches to accommodate different tools, platforms, and environments. Include both the base command and tool-specific configuration examples when applicable.

Configurations Markdown

Reviewer Prompt

When documenting configuration setup, provide multiple formats and approaches to accommodate different tools, platforms, and environments. Include both the base command and tool-specific configuration examples when applicable.

This ensures users can successfully configure the system regardless of their specific environment or tooling choices. For example, when documenting MCP server setup, provide both the CLI command and JSON configuration:

npx prisma mcp

And the JSON configuration for AI tools:

{
  "mcpServers": {
    "Prisma": {
      "command": "npx",
      "args": ["-y", "prisma", "mcp"]
    }
  }
}

Additionally, clearly document environment-specific behaviors and requirements, such as Windows-specific installation steps or path resolution differences, to help users understand and troubleshoot platform-specific issues.

2
Comments Analyzed
Markdown
Primary Language
Configurations
Category

Source Discussions