Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design review: Documentation #12

Open
krook opened this issue Jul 8, 2021 · 0 comments
Open

Design review: Documentation #12

krook opened this issue Jul 8, 2021 · 0 comments
Labels
compliance documentation Improvements or additions to documentation

Comments

@krook
Copy link
Member

krook commented Jul 8, 2021

Update and improve documentation.

Currently, the design of the system is documented between two markdown documents with general instructions for assembly. Ultimately, the entire design should be self-documented using standard schematic capture software, and the goal of the next revision should be automated assembly. This means that the documentation exists as a standalone package and can be sent to any manufacturer, with an automatic understanding of the design and how to build it without additional instruction.

The current design documentation should be replaced with updated instructions on how to set up a minimum hardware environment with off-the-shelf components for open source contribution purposes. It is recommended that a PCB development kit is designed to satisfy this need for the general community.

@krook krook transferred this issue from Pyrrha-Platform/Pyrrha-Firmware Jul 20, 2021
@krook krook added documentation Improvements or additions to documentation compliance labels Jul 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compliance documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant