Skip to content

Template to standardize enclosure designs #592

Open
@kdmukai

Description

@kdmukai

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions