Skip to content

add doc#6

Open
cuiqiyun wants to merge 12 commits intoruyisdk:mainfrom
cuiqiyun:main
Open

add doc#6
cuiqiyun wants to merge 12 commits intoruyisdk:mainfrom
cuiqiyun:main

Conversation

@cuiqiyun
Copy link
Copy Markdown

@cuiqiyun cuiqiyun commented Apr 28, 2026

Summary by Sourcery

Add user-facing documentation for multiple Milk-V Duo256m RuyiSDK sample projects.

Documentation:

  • Add a guide for running the 2048 sample on Milk-V Duo256m with RuyiSDK.
  • Add a guide for the blink example on Milk-V Duo256m using RuyiSDK.
  • Add documentation for the mailbox-test sample on Milk-V Duo256m with RuyiSDK.
  • Add usage instructions for the opencv-mobile sample on Milk-V Duo256m with RuyiSDK.
  • Add a guide for the tiny-AES-c sample on Milk-V Duo256m with RuyiSDK.
  • Add documentation for the zstd sample on Milk-V Duo256m with RuyiSDK.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 28, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds new Chinese-language Markdown documentation files describing how to use RuyiSDK with various Milk-V Duo256m sample projects (2048, blink, mailbox-test, opencv-mobile, tiny-AES-c, zstd).

File-Level Changes

Change Details Files
Add documentation pages for several Milk-V Duo256m example projects.
  • Create Markdown guide for running the 2048 demo on Milk-V Duo256m using RuyiSDK.
  • Create Markdown guide for building and running the blink example on Milk-V Duo256m using RuyiSDK.
  • Create Markdown guide for building and running the mailbox-test example on Milk-V Duo256m using RuyiSDK.
  • Create Markdown guide for building and running the opencv-mobile example on Milk-V Duo256m using RuyiSDK.
  • Create Markdown guide for building and running the tiny-AES-c example on Milk-V Duo256m using RuyiSDK.
  • Create Markdown guide for building and running the zstd example on Milk-V Duo256m using RuyiSDK.
b/Duo_256m/2048/《…RuyiSDK … Milk-V Duo256m … 2048…指南.md…
b/Duo_256m/blink/《…RuyiSDK … Milk-V Duo256m … blink…指南.md
b/Duo_256m/mailbox-test/《…RuyiSDK … Milk-V Duo256m … mailbox-test…指南.md
b/Duo_256m/opencv-mobile/《…RuyiSDK … Milk-V Duo256M … opencv-mobile…指南.md
b/Duo_256m/tiny-AES-c/《…RuyiSDK … Milk-V Duo256m … tiny-AES-c…指南.md
b/Duo_256m/zstd/《…RuyiSDK … Milk-V Duo256m … zstd…指南.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

Copy link
Copy Markdown

@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 left some high level feedback:

  • The new Markdown files use quoted paths with spaces, mixed casing, and non-ASCII characters (including what looks like an extra b/ segment), which may cause portability and tooling issues—consider normalizing the filenames (ASCII-only, consistent case, no spaces) and simplifying the directory structure.
  • File names like Milk-V Duo256M vs Milk-V Duo256m are inconsistent in capitalization; aligning these will make it easier to discover and reference the docs programmatically.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new Markdown files use quoted paths with spaces, mixed casing, and non-ASCII characters (including what looks like an extra `b/` segment), which may cause portability and tooling issues—consider normalizing the filenames (ASCII-only, consistent case, no spaces) and simplifying the directory structure.
- File names like `Milk-V Duo256M` vs `Milk-V Duo256m` are inconsistent in capitalization; aligning these will make it easier to discover and reference the docs programmatically.

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