Document magic.json contract in README#257
Open
Copilot wants to merge 5 commits into
Open
Conversation
Copilot
AI
changed the title
[WIP] Update README.md to include magic.json details
Document Jun 5, 2026
magic.json contract in README
tyeth
approved these changes
Jun 5, 2026
Added section on visualizations and UI control customization.
Added recommendation for configuring components via settings cog.
Member
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.
README’s
magic.jsonsection was a single high-level paragraph and did not describe the file contract. This PR adds a concise, schema-aligned spec so contributors know what belongs inmagic.jsonand how to produce it reliably.What was missing
magic.jsonpurpose as Adafruit IO export metadata for built-in board components./boards/magic_schema.json.Schema contract added
exportVersion,exportedBy,exportedAt,exportedFromDevice,components.exportedFromDevicekeys:board,firmwareVersion.name,type.oneOf: pin/I2C/PWM/pixel/DS18X20/UART/servo/display).Authoring guidance
magic.jsonrather than hand-crafting.magic.jsonfiles for reference.Example (added format guidance)