From 1c62ba0a64f421429fac90abab806754dc7eceed Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Sun, 15 Mar 2026 09:53:57 +0000 Subject: [PATCH] feat(package): add project metadata, release configuration, and README documentation --- changelog.md | 18 ++++++++++++++++++ npmextra.json | 21 +++++++++++++++++++++ package.json | 20 +++++++++++++++++++- pnpm-build-config.json | 1 + readme.md | 41 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 changelog.md create mode 100644 npmextra.json create mode 100644 pnpm-build-config.json create mode 100644 readme.md diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..edfabf7 --- /dev/null +++ b/changelog.md @@ -0,0 +1,18 @@ +# Changelog + +## 2026-03-15 - 1.1.0 - feat(package) +add project metadata, release configuration, and README documentation + +- add npmextra release configuration for publishing metadata and registries +- expand package metadata with repository, homepage, author, keywords, and updated project description +- add pnpm build config for esbuild and puppeteer +- introduce a README describing the specification scope, design principles, and PDF build workflow + +## 2026-03-08 - 1.0.0 - initial specification +Initial house specification covering HVAC, sensors, construction coordination, and finish systems. + +- Defined whole-house air system with H13 HEPA filtration, MVHR, duct design, and pressure management +- Documented sensor placement, automation logic, Home Assistant integration, and wiring +- Added Baufritz builder coordination details, construction checkpoints, and project timeline +- Specified Lindner NORTEC Doppelboden with WOODline parquet and Plafotherm AirHybrid radiant ceiling +- Introduced the documentation build system using tsx, marked, and puppeteer with Mermaid-to-PDF rendering \ No newline at end of file diff --git a/npmextra.json b/npmextra.json new file mode 100644 index 0000000..2c29016 --- /dev/null +++ b/npmextra.json @@ -0,0 +1,21 @@ +{ + "@git.zone/cli": { + "release": { + "registries": [ + "https://verdaccio.lossless.digital", + "https://registry.npmjs.org" + ], + "accessLevel": "public" + }, + "projectType": "npm", + "module": { + "githost": "code.foss.global", + "gitscope": "maintainable.xyz", + "gitrepo": "house-spec", + "description": "a house spec for maintainable houses", + "npmPackagename": "@maintainable.xyz/house-spec", + "license": "MIT" + } + }, + "@ship.zone/szci": {} +} \ No newline at end of file diff --git a/package.json b/package.json index 7091121..3d5ac94 100644 --- a/package.json +++ b/package.json @@ -2,11 +2,29 @@ "name": "@maintainable.xyz/house-spec", "version": "1.0.0", "private": true, - "description": "Baufritz house specification \u2014 air system, sensors, and builder coordination", + "description": "Open specification for building maximally maintainable, healthy homes — H13 HEPA air system, Lindner Doppelboden, Plafotherm ceiling, Baufritz timber-frame", "type": "module", "scripts": { "build": "tsx build.ts" }, + "repository": { + "type": "git", + "url": "https://code.foss.global/maintainable.xyz/house-spec.git" + }, + "homepage": "https://maintainable.xyz", + "license": "UNLICENSED", + "author": "maintainable.xyz", + "keywords": [ + "house", + "specification", + "baufritz", + "hepa", + "air-quality", + "lindner", + "doppelboden", + "plafotherm", + "maintainability" + ], "devDependencies": { "tsx": "^4.19.0", "marked": "^15.0.0", diff --git a/pnpm-build-config.json b/pnpm-build-config.json new file mode 100644 index 0000000..fad474d --- /dev/null +++ b/pnpm-build-config.json @@ -0,0 +1 @@ +{"onlyBuiltDependencies": ["esbuild", "puppeteer"]} diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..16186c6 --- /dev/null +++ b/readme.md @@ -0,0 +1,41 @@ +# @maintainable.xyz/house-spec + +The open specification for building maximally maintainable, healthy homes. + +## What This Is + +A complete, opinionated building specification for a Baufritz timber-frame house engineered around **clean-room-level indoor air quality** and **lifetime maintainability**. Every system — air filtration, heating, flooring, wiring — is designed so that components can be inspected, serviced, and replaced without destructive intervention. + +## Specification Documents + +| Spec | Scope | +|------|-------| +| [01 — Air System](specs/01-air-system-spec.md) | H13 HEPA whole-house filtration, MVHR, steam humidification, duct design, pressure management | +| [02 — Sensors & Automation](specs/02-sensor-automation-spec.md) | Per-room air quality sensors, KNX/Zigbee architecture, Home Assistant integration, demand-controlled ventilation | +| [03 — Baufritz Coordination](specs/03-baufritz-coordination-spec.md) | Technical room, duct routing, airtightness, radon protection, construction checkpoints | +| [04 — Flooring & Ceiling](specs/04-flooring-ceiling-spec.md) | Lindner NORTEC Doppelboden raised floor, WOODline parquet, Plafotherm AirHybrid radiant ceiling | + +## Key Design Principles + +- **Whole-house H13 HEPA** — 99.95% particle capture at 0.3 um, ISO Class 7-8 equivalent +- **Every air parameter controlled** — particulates, CO2, VOCs, humidity, temperature, pressure, radon +- **Heating via ceiling** (Plafotherm AirHybrid), not floor — fast response, furniture-independent, integrates MVHR supply air +- **Raised access floor** (Lindner NORTEC Doppelboden) — individually liftable 600x600 mm panels for full access to services underneath +- **Dry construction throughout** — no wet trades, ideal for Baufritz timber-frame +- **Positive pressure** (+3-5 Pa) — unfiltered air never enters the building envelope + +## PDF Build + +The specs can be compiled into a single styled PDF with rendered Mermaid diagrams: + +```sh +pnpm install +pnpm build +# Output: dist/house-spec.pdf +``` + +Requires Chromium (installed automatically via Puppeteer). + +## License + +All rights reserved. Copyright maintainable.xyz.