docs: Restructure the docs and add a docs folder #42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the documentation by introducing a dedicated docs folder containing detailed guides on installation, configuration, and usage of the Trivy MCP Server Plugin. It also updates the main README to provide a concise overview and clear navigation to the new documentation sections.
- Adds new documents for quick start, installation, various IDE integrations (VS Code, Cursor, JetBrains, Claude Desktop), example queries, configuration options, and authentication.
- Updates the main README to streamline and consolidate links to the documentation.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/quickstart.md | New quick start guide covering installation and server startup |
| docs/installation.md | Detailed installation guide for the MCP plugin |
| docs/ide/vscode.md | VS Code integration instructions with configuration examples |
| docs/ide/jetbrains.md | JetBrains IDE integration guide with setup instructions |
| docs/ide/cursor.md | Cursor integration guide and configuration steps |
| docs/ide/claude.md | Claude Desktop integration guide with configuration details |
| docs/example-queries.md | Example queries for local, container, and repository analysis |
| docs/configuration.md | Overview of available configuration options and commands |
| docs/authentication.md | Instructions for Aqua Platform authentication and credential management |
| docs/README.md | Updated docs overview and table of contents |
| README.md | Simplified plugin README linking to the new documentation structure |
Comments suppressed due to low confidence (2)
docs/quickstart.md:34
- [nitpick] The shorthand flag 'a' may be unclear. For greater clarity and consistency with other flags, consider using '-a' or providing a brief note on this shorthand convention.
| `--use-aqua-platform` / `a` | `true/false` | `false` | Enable Aqua Platform integration |
docs/ide/vscode.md:40
- [nitpick] The long instruction text within the JSON sample could be split into multiple lines or rephrased for better readability. Consider formatting it with line breaks to enhance clarity for users editing their settings.
"github.copilot.chat.codeGeneration.instructions": [
Create a docs folder with a break down of useful installation and usage steps
3135843 to
878c665
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create a docs folder with a break down of useful installation and usage
steps