---
name: 📚 Documentation Issue
about: Report missing, incorrect, or unclear documentation
title: 'docs: '
labels: ['documentation', 'needs-triage']
assignees: ''
---
# 📚 Documentation Issue
## 📝 Issue Type
<!-- Mark the appropriate option with an 'x' -->
- [ ] 📝 Missing documentation
- [ ] 🐛 Incorrect documentation
- [ ] 🔍 Unclear/confusing documentation
- [ ] 🔗 Broken links
- [ ] 🌐 Translation needed
- [ ] ✨ Documentation enhancement
- [ ] 🧹 Outdated documentation
## 📍 Location
<!-- Where is the documentation issue located? -->
- **File**: [e.g., README.md, PROTOCOL.md, docs/api.md]
- **Section**: [e.g., Installation, API Reference, Examples]
- **URL**: [e.g., https://github.com/jerfowler/agent-comm-mcp-server#installation]
## 🔍 Current State
<!-- What is currently documented (if anything)? -->
<!-- Include relevant quotes from the current documentation -->
### Current Documentation
```markdown
<!-- Paste the current documentation here -->
```
## ❌ Problem Description
<!-- What is wrong, missing, or unclear? -->
<!-- Be as specific as possible -->
### Specific Issues
- [ ] Information is completely missing
- [ ] Information is outdated
- [ ] Examples don't work
- [ ] Steps are unclear
- [ ] Technical details are incorrect
- [ ] Links are broken
- [ ] Formatting is broken
- [ ] Code snippets have errors
### Impact
- [ ] Prevents users from getting started
- [ ] Causes confusion during development
- [ ] Leads to incorrect implementation
- [ ] Makes troubleshooting difficult
- [ ] Affects API usage
## ✅ Expected Documentation
<!-- What should the documentation say/include? -->
### Proposed Content
```markdown
<!-- Your suggested documentation content -->
```
### Required Information
<!-- What specific information needs to be included? -->
- [ ] Clear step-by-step instructions
- [ ] Working code examples
- [ ] Error handling examples
- [ ] Configuration options
- [ ] Troubleshooting section
- [ ] API reference
- [ ] Best practices
## 🎯 Target Audience
<!-- Who is this documentation for? -->
- [ ] New users/getting started
- [ ] Developers integrating the package
- [ ] Contributors to the project
- [ ] MCP protocol implementers
- [ ] Advanced users/power users
## 🌍 Context
<!-- Additional context that helps understand the issue -->
### User Journey
<!-- What is the user trying to accomplish? -->
1. User wants to...
2. User goes to...
3. User expects to find...
4. But instead finds...
### Related Functionality
<!-- What features/APIs are related to this documentation? -->
### Dependencies/Prerequisites
<!-- What should users know before reading this documentation? -->
## 💡 Suggested Solutions
<!-- If you have ideas for how to fix this -->
### Content Improvements
<!-- Specific content suggestions -->
### Structural Changes
<!-- Changes to organization/layout -->
### Additional Resources
<!-- Links, examples, or references that would help -->
## 📸 Screenshots/Examples
<!-- If applicable, add screenshots showing the problem -->
<!-- Or examples of good documentation from similar projects -->
### Current State
<!-- Screenshot/example of current documentation -->
### Desired State
<!-- Screenshot/example of how it should look -->
## 🔗 Related Issues
<!-- Link any related issues or pull requests -->
- Related to #
- Fixes #
- Depends on #
## 📋 Documentation Checklist
<!-- For comprehensive documentation improvements -->
### Content Quality
- [ ] Clear and concise language
- [ ] Accurate technical information
- [ ] Up-to-date examples
- [ ] Proper grammar/spelling
- [ ] Consistent terminology
### Structure
- [ ] Logical organization
- [ ] Proper headings/sections
- [ ] Table of contents (if needed)
- [ ] Cross-references
- [ ] Navigation elements
### Examples
- [ ] Working code examples
- [ ] Real-world use cases
- [ ] Error handling examples
- [ ] Configuration examples
- [ ] Integration examples
### Accessibility
- [ ] Alt text for images
- [ ] Descriptive link text
- [ ] Proper markdown formatting
- [ ] Screen reader friendly
- [ ] Multiple format support
## 🤝 Contribution
<!-- Are you willing to help improve this documentation? -->
- [ ] I can write the missing documentation
- [ ] I can review/edit existing content
- [ ] I can provide examples/use cases
- [ ] I can test documentation accuracy
- [ ] I'm unable to contribute directly
## 📚 Reference Materials
<!-- Links to helpful resources -->
### Official Documentation
<!-- Links to MCP protocol docs, Node.js docs, etc. -->
### Similar Projects
<!-- Examples from other projects with good documentation -->
### Style Guides
<!-- Documentation style references -->
## 🔧 Technical Details
<!-- If the issue involves code examples or API docs -->
### Environment
- **Node.js Version**: [e.g., 18.17.0]
- **Package Version**: [e.g., 0.6.0]
- **Operating System**: [e.g., Ubuntu 22.04]
### Code Context
```typescript
// Relevant code that needs documentation
```
## 📝 Additional Notes
<!-- Any other information that might be helpful -->
## 📋 Final Checklist
- [ ] I have searched existing issues for similar documentation requests
- [ ] I have provided specific details about the problem
- [ ] I have suggested concrete improvements
- [ ] I have considered the target audience
- [ ] I have checked for related issues/PRs
## 🏷 Labels
Suggested labels: documentation, needs-triage
<!-- Thank you for helping improve our documentation! -->
