Skip to content

[DOCS] #422

@joe10832

Description

@joe10832

Documentation Issue Type

  • Error in existing documentation
  • Missing documentation
  • Unclear or confusing documentation
  • Example code not working
  • Request for additional examples

Location

Where is the documentation issue located?

  • README.md
  • API documentation (JSDoc comments)
  • Examples in /example directory
  • Documentation in /docs directory
  • GitHub Copilot instructions (.github/copilot-instructions.md)
  • Contributing guide
  • Other: ____________

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

  • I have searched for existing documentation issues
  • I have checked if this is covered in other sections
  • I have provided specific suggestions for improvement
  • I have included relevant code examples (if applicable)

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions