surshar / claude-code
Claude Code is an agentic coding tool that lives in your terminal, understands your codebase, and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows - all through natural language commands.
Built by Anthropic · github.com/anthropics
| 1 | name: 📚 Documentation Issue |
| 2 | description: Report missing, unclear, or incorrect documentation |
| 3 | title: "[DOCS] " |
| 4 | labels: |
| 5 | - documentation |
| 6 | body: |
| 7 | - type: markdown |
| 8 | attributes: |
| 9 | value: | |
| 10 | ## Help us improve our documentation! |
| 11 | |
| 12 | Good documentation is crucial for a great developer experience. Please let us know what's missing or confusing. |
| 13 | |
| 14 | - type: dropdown |
| 15 | id: doc_type |
| 16 | attributes: |
| 17 | label: Documentation Type |
| 18 | description: What kind of documentation issue is this? |
| 19 | options: |
| 20 | - Missing documentation (feature not documented) |
| 21 | - Unclear/confusing documentation |
| 22 | - Incorrect/outdated documentation |
| 23 | - Typo or formatting issue |
| 24 | - Missing code examples |
| 25 | - Broken links |
| 26 | - Other |
| 27 | validations: |
| 28 | required: true |
| 29 | |
| 30 | - type: input |
| 31 | id: location |
| 32 | attributes: |
| 33 | label: Documentation Location |
| 34 | description: Where did you encounter this issue? Provide a URL if possible |
| 35 | placeholder: "e.g., https://docs.anthropic.com/en/docs/claude-code/getting-started" |
| 36 | validations: |
| 37 | required: false |
| 38 | |
| 39 | - type: input |
| 40 | id: section |
| 41 | attributes: |
| 42 | label: Section/Topic |
| 43 | description: Which specific section or topic needs improvement? |
| 44 | placeholder: "e.g., MCP Server Configuration section" |
| 45 | validations: |
| 46 | required: true |
| 47 | |
| 48 | - type: textarea |
| 49 | id: current |
| 50 | attributes: |
| 51 | label: Current Documentation |
| 52 | description: | |
| 53 | What does the documentation currently say? |
| 54 | Quote the specific text if applicable. |
| 55 | placeholder: | |
| 56 | The docs currently say: |
| 57 | "To configure MCP servers, add them to your configuration..." |
| 58 | |
| 59 | But it doesn't explain... |
| 60 | validations: |
| 61 | required: false |
| 62 | |
| 63 | - type: textarea |
| 64 | id: issue |
| 65 | attributes: |
| 66 | label: What's Wrong or Missing? |
| 67 | description: Explain what's incorrect, unclear, or missing |
| 68 | placeholder: | |
| 69 | The documentation doesn't explain how to: |
| 70 | - Configure multiple MCP servers |
| 71 | - Handle authentication |
| 72 | - Debug connection issues |
| 73 | |
| 74 | The example code doesn't work because... |
| 75 | validations: |
| 76 | required: true |
| 77 | |
| 78 | - type: textarea |
| 79 | id: suggested |
| 80 | attributes: |
| 81 | label: Suggested Improvement |
| 82 | description: How should the documentation be improved? Provide suggested text if possible |
| 83 | placeholder: | |
| 84 | The documentation should include: |
| 85 | |
| 86 | 1. A complete example showing... |
| 87 | 2. Explanation of common errors like... |
| 88 | 3. Step-by-step guide for... |
| 89 | |
| 90 | Suggested text: |
| 91 | "To configure multiple MCP servers, create an array in your settings..." |
| 92 | validations: |
| 93 | required: true |
| 94 | |
| 95 | - type: dropdown |
| 96 | id: impact |
| 97 | attributes: |
| 98 | label: Impact |
| 99 | description: How much does this documentation issue affect users? |
| 100 | options: |
| 101 | - High - Prevents users from using a feature |
| 102 | - Medium - Makes feature difficult to understand |
| 103 | - Low - Minor confusion or inconvenience |
| 104 | validations: |
| 105 | required: true |
| 106 | |
| 107 | - type: textarea |
| 108 | id: additional |
| 109 | attributes: |
| 110 | label: Additional Context |
| 111 | description: | |
| 112 | - Screenshots showing the issue |
| 113 | - Links to related documentation |
| 114 | - Examples from other projects that do this well |
| 115 | placeholder: Any additional information that would help... |
| 116 | validations: |
| 117 | required: false |