Skip to content

NO-TICKET: docs: Add instrumentation README template and generated module docs - #1644

Draft
SenNeonoveNoci wants to merge 1 commit into
developfrom
docs/instrumentation_readme
Draft

NO-TICKET: docs: Add instrumentation README template and generated module docs#1644
SenNeonoveNoci wants to merge 1 commit into
developfrom
docs/instrumentation_readme

Conversation

@SenNeonoveNoci

Copy link
Copy Markdown
Contributor

Adds a shared instrumentation README template, guidelines, and Codex skill for generating consistent module documentation. Generates README files for all integration/<module> instrumentations and links the process from CONTRIBUTING.md and agents.md so future instrumentation changes include matching documentation updates.

Checklist

  • My code follows the project's coding standards.
  • I have run linters/formatters and fixed any issues.
  • There are no merge conflicts.
  • I have performed a self-review of my code.
  • All new and existing tests pass locally.
  • I have added license headers to all files.

Generative AI usage

  • GAI was not used (or, no additional notation is required)
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • GAI was used to create a draft that was subsequently customized or modified
  • Code was generated entirely by GAI

@SenNeonoveNoci SenNeonoveNoci self-assigned this Jun 8, 2026
@SenNeonoveNoci
SenNeonoveNoci requested a review from a team as a code owner June 8, 2026 13:32
@SenNeonoveNoci SenNeonoveNoci added the documentation Improvements or additions to documentation label Jun 8, 2026
@SenNeonoveNoci
SenNeonoveNoci marked this pull request as draft June 8, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant