@protoboardai/ext-docs 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +13 -2
- package/protoboard-extension.json +16 -5
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@protoboardai/ext-docs",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"description": "Protoboard extension:
|
|
3
|
+
"version": "0.2.1",
|
|
4
|
+
"description": "Protoboard extension: datasheets and assembly guides generated from your design.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "Delta Robotics, Inc.",
|
|
7
7
|
"repository": {
|
|
@@ -49,5 +49,16 @@
|
|
|
49
49
|
"@protoboardai/ext-release": {
|
|
50
50
|
"optional": true
|
|
51
51
|
}
|
|
52
|
+
},
|
|
53
|
+
"keywords": [
|
|
54
|
+
"protoboard",
|
|
55
|
+
"hardware",
|
|
56
|
+
"documentation",
|
|
57
|
+
"datasheet",
|
|
58
|
+
"pdf"
|
|
59
|
+
],
|
|
60
|
+
"homepage": "https://protoboard.ai",
|
|
61
|
+
"bugs": {
|
|
62
|
+
"url": "https://github.com/Delta-Robotics-Inc/protoboard-stack/issues"
|
|
52
63
|
}
|
|
53
64
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schema": "protoboard.extension/v0",
|
|
3
3
|
"id": "@protoboardai/ext-docs",
|
|
4
|
-
"version": "0.2.
|
|
4
|
+
"version": "0.2.1",
|
|
5
5
|
"description": "Technical documents (datasheet, assembly guide) for a project's system: every value a query into the UHD model, figures rendered from the CAD artifacts, stand-in test data watermarked until measured data replaces it, and a verifier.",
|
|
6
6
|
"compatibility": {
|
|
7
7
|
"protoboard": "^0.2.0",
|
|
@@ -24,13 +24,19 @@
|
|
|
24
24
|
{
|
|
25
25
|
"id": "chrome",
|
|
26
26
|
"purpose": "A Chromium-family browser (Google Chrome, Chromium, Microsoft Edge or Brave), run headless: the datasheet and the assembly guide are laid out, their figures drawn and the PDFs printed with it",
|
|
27
|
-
"probe": [
|
|
27
|
+
"probe": [
|
|
28
|
+
"protoboard:browser"
|
|
29
|
+
],
|
|
28
30
|
"install": "install Google Chrome, Chromium, Microsoft Edge or Brave (found where each platform installs them), or set CHROME to a browser's executable"
|
|
29
31
|
},
|
|
30
32
|
{
|
|
31
33
|
"id": "poppler",
|
|
32
34
|
"purpose": "poppler-utils: pdfinfo, pdffonts (document checks) and pdftoppm (review page images)",
|
|
33
|
-
"probe": [
|
|
35
|
+
"probe": [
|
|
36
|
+
"sh",
|
|
37
|
+
"-c",
|
|
38
|
+
"exec pdfinfo -v 2>&1"
|
|
39
|
+
],
|
|
34
40
|
"install": "apt install poppler-utils (brew install poppler)"
|
|
35
41
|
}
|
|
36
42
|
],
|
|
@@ -40,7 +46,9 @@
|
|
|
40
46
|
"summary": "Build the datasheet and assembly guide (HTML, PDF, bound values) for the project's root system from its model, CAD artifacts and docs/docspec.ts; stand-in test data is refreshed, measured data kept",
|
|
41
47
|
"entry": "./ops/docs.ts#techDocs",
|
|
42
48
|
"effect": "export",
|
|
43
|
-
"requires": [
|
|
49
|
+
"requires": [
|
|
50
|
+
"chrome"
|
|
51
|
+
],
|
|
44
52
|
"inputs": {
|
|
45
53
|
"only": {
|
|
46
54
|
"description": "datasheet or assembly (default: both)"
|
|
@@ -60,7 +68,10 @@
|
|
|
60
68
|
"summary": "Verify the built documents against the live model: values, units, placeholders, stand-in marks, images, layout, typography, BOM, assembly coverage; fails on any error",
|
|
61
69
|
"entry": "./ops/docs.ts#techDocsVerify",
|
|
62
70
|
"effect": "export",
|
|
63
|
-
"requires": [
|
|
71
|
+
"requires": [
|
|
72
|
+
"chrome",
|
|
73
|
+
"poppler"
|
|
74
|
+
],
|
|
64
75
|
"inputs": {
|
|
65
76
|
"only": {
|
|
66
77
|
"description": "datasheet or assembly (default: both)"
|