Add AI Agent friendly documentation

Open
#251 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Tech stack
matlab
Domain
documentation

Research direction

Start by reviewing the existing documentation for makeCurrent, the RAII pattern involving span and scope objects, and the global Tracer Provider. Document these MATLAB instrumentation concepts with guidance for generating correct code, and consider the work done when AI agents have clear instructions for each identified syntax challenge.

Written by the indexing model from the issue text.

Description

documentation

AI Agents struggles with syntax such as implicit context passing (makeCurrent), RAII pattern of span and scope objects, and global Tracer Provider. They need more documentation to guide them to generate good instrumentation code.

Dominant language
MATLAB
Stars
19
Forks
4
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mathworks/OpenTelemetry-MATLAB

All issues in mathworks/OpenTelemetry-MATLAB

Similar issues

More MATLAB issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.