Skip to content

techofourown/pub-webuild

typeId publication_series
recordId webuild
fields
name description status started
We Build
A publication series documenting the process, decisions, and techniques involved in building hardware projects
active
2025-02

We Build

A publication series about hardware building, documenting the process, decisions, and techniques we use to create physical things.

What This Is

We Build is narrative/editorial content about the journey of building hardware projects. Unlike product documentation (specifications, BOMs, assembly instructions), this series focuses on:

  • Process: How we approached problems and made progress
  • Decisions: Why we chose specific components, techniques, or approaches
  • Techniques: Methods and workflows we developed or refined
  • Learning: What worked, what didn't, and what we'd do differently

This repository is structured as a GraphMD dataset for metadata management while maintaining author-friendly organization.

Published Articles

(No published articles yet)

Draft Articles

Repository Structure

pub-webuild/
├── articles/           # Published and draft articles
│   ├── YYYY-MM-slug/   # Published articles (date-prefixed)
│   └── drafts/         # Work-in-progress articles
├── types/              # GraphMD type definitions
├── docs/               # Publication policy documentation
│   ├── decisions/      # ADRs (Architectural Decision Records)
│   └── rfcs/          # RFCs (Request for Comments)
└── tools/              # Validation tooling

Getting Started

Prerequisites

  • Node.js 20+
  • npm

Commands

npm ci              # Install dependencies (deterministic)
npm test            # Validate GraphMD dataset

Contributing

This publication series follows:

  • Conventional Commits for commit messages (enforced via commitlint)
  • GraphMD dataset validation in CI (all articles have proper metadata)
  • Single authorship principle (no Co-Authored-By or external attribution)

See CLAUDE.md for detailed guidance on publication workflows.

Navigation

License

Creative Commons License

This work is licensed under a Creative Commons Attribution 4.0 International License.

You are free to share and adapt this content with attribution.

About

We Build publication series documenting hardware build process, decisions, and techniques.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors