docs: refresh LoongSuite integration guides and fix util-genai standalone init#159
Merged
Merged
Conversation
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>
sipercai
approved these changes
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
What changed
Top-level integration documentation
The root
README.mdwas 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 singlepip installcommand 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.mdguides were updated to remove outdated source/bootstrap patterns and align with root recommendations:pip install loongsuite-instrumentation-*).agno,dify,mcp) now document Option A (loongsuite-bootstrap -a install --latest).loongsuite-instrument.LoongSuite component docs/changelog alignment
loongsuite-distroREADME content was migrated from RST to Markdown,pyproject.tomlreadme metadata was updated toREADME.md, and the old RST file now redirects readers.loongsuite-site-bootstrap/README.mdwas updated to clarify its role and how it works together withloongsuite-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.pyadded bypass logic to avoid hard dependency on instrumentation initialization flow, soopentelemetry-util-genaican operate as a standalone SDK in non-instrumentation setups. The fix is documented inutil/opentelemetry-util-genai/CHANGELOG-loongsuite.md.Documentation
README.md,README-zh.mdupdated for integration guidance and bilingual navigation.instrumentation-loongsuite/*/README.mdfiles updated to recommended Option A/C onboarding.Type of change
Please delete options that are not relevant.
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.