Skip to content

docs: refresh LoongSuite integration guides and fix util-genai standalone init#159

Merged
Cirilla-zmh merged 10 commits into
alibaba:mainfrom
Cirilla-zmh:docs/integration
Mar 27, 2026
Merged

docs: refresh LoongSuite integration guides and fix util-genai standalone init#159
Cirilla-zmh merged 10 commits into
alibaba:mainfrom
Cirilla-zmh:docs/integration

Conversation

@Cirilla-zmh

Copy link
Copy Markdown
Collaborator

Description

What changed

Top-level integration documentation

The root README.md was reworked to align around the LoongSuite-recommended integration path (loongsuite-distro + loongsuite-bootstrap + loongsuite-instrument), with clearer Option A/B/C guidance and source-install instructions. The source-install section now emphasizes installing core and local editable packages in a single pip install command to avoid resolver-induced version replacement in split installs, and OTLP exporter prerequisites were clarified.

Chinese documentation and language switch

A full Chinese translation was added as README-zh.md, and both top-level READMEs now include a centered language switch block at the top for quick navigation between English and Simplified Chinese.

Instrumentation package integration flow refresh

Multiple instrumentation-loongsuite/*/README.md guides were updated to remove outdated source/bootstrap patterns and align with root recommendations:

  • Packages with PyPI release path now document Option C (pip install loongsuite-instrumentation-*).
  • Packages not yet on PyPI (agno, dify, mcp) now document Option A (loongsuite-bootstrap -a install --latest).
  • Runtime examples consistently prefer loongsuite-instrument.

LoongSuite component docs/changelog alignment

loongsuite-distro README content was migrated from RST to Markdown, pyproject.toml readme metadata was updated to README.md, and the old RST file now redirects readers. loongsuite-site-bootstrap/README.md was updated to clarify its role and how it works together with loongsuite-bootstrap. Top-level and per-package changelogs were updated to reflect this docs pass.

util-genai standalone compatibility fix

util/opentelemetry-util-genai/src/opentelemetry/util/genai/utils.py added bypass logic to avoid hard dependency on instrumentation initialization flow, so opentelemetry-util-genai can operate as a standalone SDK in non-instrumentation setups. The fix is documented in util/opentelemetry-util-genai/CHANGELOG-loongsuite.md.

Documentation

  • Top-level docs: README.md, README-zh.md updated for integration guidance and bilingual navigation.
  • Instrumentation docs: multiple instrumentation-loongsuite/*/README.md files updated to recommended Option A/C onboarding.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Does This PR Require a Core Repo Change?

  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Documentation has been updated

Change-Id: I24e0dbe3e236c6b1be5a9f3532187e0b9911c06c
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: I66022262556ad662008e20e28a60d2bdb3d577d6
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: I52c0a2367294601b0a386dfe874a4a6de45682ab
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: I484839336784083cbc5b973482e7fa37a13a7332
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: I8db95796ce28370d3fe5a1ebdc49bb64fe3a1168
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: I9e3d5d6bfd977759568e9ef178aef9b71c3d82f8
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: Id2072e4dadb2445f16dc2f087f978689c7f7ccfb
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: Ia50b2939d3600e521a9e8d5b642cea71bba0d086
Co-developed-by: Cursor <noreply@cursor.com>
Change-Id: Id794ca24d56d0aa4456f7796a711ceaf1823ffdd
Co-developed-by: Cursor <noreply@cursor.com>
@Cirilla-zmh Cirilla-zmh added bug Something isn't working documentation Improvements or additions to documentation genai The genai label represents issues related to generative AI. labels Mar 26, 2026
Change-Id: If9c72c4b6aeb4f576d2b72740111604b0fa06735
Co-developed-by: Cursor <noreply@cursor.com>

@123liuziming 123liuziming left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@Cirilla-zmh Cirilla-zmh merged commit 257b7f1 into alibaba:main Mar 27, 2026
102 checks passed
Copilot AI mentioned this pull request Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation genai The genai label represents issues related to generative AI.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants