Proposal 0007: Usage Rules for Beam Bots Packages#7
Open
jimsynz wants to merge 2 commits into
Open
Conversation
Add usage-rules.md files to published BB packages to provide AI coding assistants with authoritative guidance for users building robots with the framework.
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
1 participant
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.
Summary
Add
usage-rules.mdfiles to published Beam Bots packages to provide AI coding assistants with authoritative, concise guidance for users building robots with BB.This leverages the
usage_ruleshex package, enabling users to run:Key Points
bb_*packages (excluding example apps)Packages Covered
bb,bb_liveview,bb_kino,bb_reactorbb_ik_dls,bb_ik_fabrikbb_servo_robotis,bb_servo_pca9685,bb_servo_pigpio,bb_servo_feetechSee the full proposal for the recommended file structure and example content.