Documentation Issue Type
Location
Where is the documentation issue located?
Current Documentation
If reporting an error or unclear section, please quote the current documentation:
Current text that has issues...
Issue Description
Clearly describe what's wrong or what's missing:
Suggested Improvement
What would you like to see instead?
Suggested text or structure...
Use Case
Describe the scenario or use case that this documentation would help with:
Additional Context
- What were you trying to accomplish when you encountered this issue?
- What documentation would have helped you?
- Are there any external resources that provide good examples?
Code Example (if applicable)
If requesting examples or reporting broken code:
// Code that should work but doesn't
// or code example you'd like to see documented
Environment (if reporting broken examples)
- Onchain Test Kit Version: [e.g., 1.2.0]
- Node.js Version: [e.g., 18.17.0]
- Operating System: [e.g., macOS 13.4]
Checklist
Documentation Issue Type
Location
Where is the documentation issue located?
/exampledirectory/docsdirectory.github/copilot-instructions.md)Current Documentation
If reporting an error or unclear section, please quote the current documentation:
Issue Description
Clearly describe what's wrong or what's missing:
Suggested Improvement
What would you like to see instead?
Use Case
Describe the scenario or use case that this documentation would help with:
Additional Context
Code Example (if applicable)
If requesting examples or reporting broken code:
Environment (if reporting broken examples)
Checklist