Skip to content

Help

If you need help getting started with Instructor or have questions about advanced usage, the following resources are available.

Documentation

  • Essentials -- covers the day-to-day API, data models, validation, and configuration.
  • Techniques -- practical patterns like classification, search query generation, and prompting guidelines.
  • Examples -- see the repository examples/ directory for ready-to-run integrations and workflows.

Community

  • GitHub Discussions -- the best place to ask questions. Your question and its answer will help others with similar problems.
  • Discord -- real-time chat with the community.

Reporting Issues

  • GitHub Issues -- use this for bug reports and feature requests. When reporting a bug, include:
  • The Instructor and PHP versions you are using.
  • A minimal code example that reproduces the problem.
  • The full error message or unexpected output.

When reporting a documentation issue, include the page path and describe how the current content differs from the actual API behavior.

Contact

You can also reach the maintainer directly: