Repository navigation
Apply the pre-release audit recommendations (audit/apply-20261004) - #23
Merged
Merged
Conversation
The README keeps this BSP's own values and links the LibXR.CMake rules and the shared CI to the website. The directory listing is a text block as in the other BSPs, commands carry no prompt, the configuration link points to the format page, and regeneration uses libxr stm32 setup, which leaves an unchanged project untouched; AGENTS.md no longer calls it a one-time command. Section 1 lists the 0.x aliases with the object names that replace them.
Reviewer's GuideThe PR applies pre-release audit recommendations by aligning contributor and user documentation with the current LibXR/CubeMX generation workflow and hardware naming conventions, and by updating both configured and generated USB descriptors to the new VID/PID and serial format. Flow diagram for the LibXR STM32 generation workflowflowchart LR
CubeMX[CubeMX project or libxr_config.yaml] --> Setup[libxr stm32 setup]
Setup --> Generated[Generated BSP files and LibXR.CMake]
Generated --> Build[CMake build and CI verification]
CI[Shared BSP CI] --> Setup
CI --> Build
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Changes recommended by the pre-release audit of 2026-10-04 and approved by the owner. Each commit names what it changes.
Summary by Sourcery
Apply the pre-release audit updates to USB identification and project documentation.
Bug Fixes:
Enhancements:
libxr stm32 setupas the standard workflow for regenerating STM32 BSP and LibXR configuration files while preserving user-code regions.Documentation: