Repository navigation
board_spec: document the exposed connector conventions, connector types, accessories, the CLI and the editor - #352
Merged
Conversation
… catalog Describe how connectors, official links and conn roles relate to detect_class, that port_a..port_e are the M5Unified pin-table contract, and how to represent undocumented placement, shared terminals and paired sockets.
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.
Summary
Documentation only (
extras/board_spec/README.md, no code or catalog data changed).port_atoport_eas the M5Unified pin-table contract, logical terminal types for undocumented layouts,multi_gpio,group, and what is not cataloged.connector_types/andaccessories/hold (layout,positions,standards,rails,verified.layout;attaches,host_pins,settings) and how accessory wiring reaches the compositions and the M5Unified pin table.cli/spec.jscommand with its output location, and whatcheckverifies (formatting plus every generated output being present and current).node cli/spec.js checkandnpm test(236 tests) pass; the README is not an input of either.