Skip to content

docs: add partner-guide.md#133

Merged
xijing21 merged 1 commit intoruyisdk:zhfrom
xijing21:zh
Feb 13, 2026
Merged

docs: add partner-guide.md#133
xijing21 merged 1 commit intoruyisdk:zhfrom
xijing21:zh

Conversation

@xijing21
Copy link
Copy Markdown
Collaborator

@xijing21 xijing21 commented Feb 13, 2026

Summary by Sourcery

Add a new partner integration guide describing how external RISC-V ecosystem resources can be onboarded into the RuyiSDK package management system.

Documentation:

  • Document RuyiSDK package management architecture and supported resource types for RISC-V developers.
  • Add detailed guidance for partners on source integration and binary distribution onboarding modes, including responsibilities and maintenance expectations.
  • Describe the end-to-end collaboration workflow for requesting, authorizing, and publishing partner resources via RuyiSDK.

Signed-off-by: xijing21 <xijing@iscas.ac.cn>
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 13, 2026

Reviewer's Guide

Adds a new Chinese-language partner integration guide document (partner-guide.md) describing how external partners can integrate RISC-V related resources into the RuyiSDK ecosystem, including architecture overview, integration modes, and collaboration workflow.

Sequence diagram for installing a package via partner self-hosted binary (方案B)

sequenceDiagram
    actor Developer
    participant RuyiClient
    participant PackagesIndex
    participant PartnerServer

    Developer ->> RuyiClient: 运行 ruyi install 包名
    RuyiClient ->> PackagesIndex: 查询包元数据
    PackagesIndex -->> RuyiClient: 返回版本信息与下载链接
    RuyiClient ->> PartnerServer: HTTP_HTTPS请求携带User_Agent_ruyi_版本号
    PartnerServer -->> RuyiClient: 返回二进制文件
    RuyiClient ->> RuyiClient: 校验哈希并安装
    RuyiClient -->> Developer: 安装结果与使用提示
Loading

File-Level Changes

Change Details Files
Introduce a new partner integration guide documenting RuyiSDK package ecosystem, supported resource types, integration modes, and collaboration流程。
  • Add high-level introduction to RuyiSDK package manager and the scope of RISC-V related resources eligible for integration
  • Document system architecture with a Mermaid diagram showing partners, build services, mirrors, and index repository
  • Describe two main resource integration modes: source integration and binary distribution (with two sub-options: mirror hosting and partner-hosted downloads) including processes, authorization, and responsibilities
  • Define collaboration workflow for partners, including issue/PR-based onboarding template, email-based contact, technical handoff, and release steps
Other/partner-guide.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@xijing21 xijing21 merged commit e27010e into ruyisdk:zh Feb 13, 2026
3 checks passed
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant