Skip to content

Conversation

@thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Nov 27, 2025

Changes

This ensures that the embed warning alert starts on a new line so that it is rendered correctly.

This issue is already present in the published docs https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/#execute-tool-span within the foot notes section.

As an aside I have raised #3142 to look at alternative options Which would remove the need for the text before the alert but it's hard to see an easy option hence the path here.

Important

Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Change log entry added, according to the guidelines in When to add a changelog entry.
    • If your PR does not need a change log, start the PR title with [chore]
  • Links to the prototypes or existing instrumentations (when adding or changing conventions)

@thompson-tomo thompson-tomo requested review from a team as code owners November 27, 2025 11:55
@thompson-tomo thompson-tomo marked this pull request as draft November 27, 2025 11:59
@thompson-tomo thompson-tomo changed the title [chore]fix formattimg of gen ai docs [chore]fix formating of gen ai docs Nov 27, 2025
note: |
> [!WARNING]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems fragile, any other options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree and it didn't end up working due to trimming. If we could add text before the note we would be fine. Hence have asked the gen-ai folks on slack for input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants