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

Template to standardize enclosure designs #592

Open
kdmukai opened this issue Aug 9, 2024 · 0 comments
Open

Template to standardize enclosure designs #592

kdmukai opened this issue Aug 9, 2024 · 0 comments

Comments

@kdmukai
Copy link
Contributor

kdmukai commented Aug 9, 2024

We should formalize and structure the READMEs for the various enclosure designs, similar to how bitcoin BIPs are rigorously templatized.

Many of the existing enclosures do have some similar structure that we can leverage but we have not rigorously applied this.

Expected fields like:

  • Design name
  • Photo
  • Designer ("@" reference to their github profile)
  • Perhaps allow for an external link to a social media post from the creator (e.g. "Unveiling my new design..." tweet thread)

And then more descriptive sections like:

  • Characteristics (which itself is a kind of formal list in some of our existing READMEs)
  • Rationale / Design Goal(?)
  • Credit to previous designs(?)
  • Secondary Hardware Required
  • Assembly Demonstration (link to video) or Assembly Steps (written instructions)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant