Tyler/autodoc
1
0
Fork 0
Code Issues 7 Pull Requests Actions 16 Packages Projects Releases Wiki Activity

Add sample guide, sample exports, and enriched build report

Browse Source 
- examples/: sample guide store, .sfgz share archive, and exported
  output in all nine formats (JSON/MD/HTML×2/PDF/GIF/images/DOCX/PPTX)
- build_report.md now records packaging tool availability, fallback
  policy, offline guarantee, and verification entrypoints
- artifacts_manifest.json with sha256 checksums for packages + samples
- CHANGELOG entries for the welcome screen and renderer fixes

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Iisyourdad
2026-06-10 21:33:58 -05:00
parent 03bd9b0e2b
commit a0a1bb5cfc
37 changed files with 1245 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/sample-exports/json/reset-a-password-in-admin-portal.json
+255
View File
@@ -0,0 +1,255 @@
{
"format": "stepforge-guide",
"version": 1,
"generatedAt": "2026-06-11T02:32:07.575Z",
"guide": {
"title": "Reset a password in Admin Portal",
"descriptionHtml": "<p>Offline sample guide showing capture, annotations, rich text, and exports.</p>",
"createdAt": "2026-06-11T02:32:07Z",
"updatedAt": "2026-06-11T02:32:07Z"
},
"steps": [
{
"number": "1",
"kind": "image",
"status": "todo",
"title": "Open Admin Portal users",
"descriptionHtml": "<p>Open the users list and select the target account.</p>",
"descriptionText": "Open the users list and select the target account.",
"image": {
"relPath": "steps-reset-a-password-in-admin-portal/001-open-admin-portal-users.png",
"width": 1280,
"height": 760
},
"annotations": [
{
"id": "ann-54403181-b784-4d9b-9285-b9504a7c2f8d",
"type": "rect",
"x": 0.275,
"y": 0.18,
"w": 0.19,
"h": 0.18,
"text": "",
"style": {
"stroke": "#0068ff",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 6,
"fontSize": 0.022
}
},
{
"id": "ann-303a7cdc-4866-4667-8046-33ba7bfb8687",
"type": "number",
"x": 0.3,
"y": 0.08,
"w": 0.08,
"h": 0.12,
"text": "",
"style": {
"stroke": "#0068ff",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 3,
"fontSize": 0.022
},
"value": 1
}
],
"textBlocks": [
{
"position": "after-description",
"level": "info",
"title": "Tip",
"descriptionHtml": "<p>Use the search box to avoid scrolling.</p>"
}
],
"codeBlocks": [],
"tableBlocks": [],
"links": []
},
{
"number": "2",
"kind": "image",
"status": "todo",
"title": "Enable the reset policy",
"descriptionHtml": "<p>Make sure the policy is active before continuing.</p>",
"descriptionText": "Make sure the policy is active before continuing.",
"image": {
"relPath": "steps-reset-a-password-in-admin-portal/002-enable-the-reset-policy.png",
"width": 1280,
"height": 760
},
"annotations": [
{
"id": "ann-80ff688a-e1ca-46e7-9519-0dd38240d9c3",
"type": "arrow",
"x": 0.47,
"y": 0.24,
"w": 0.23,
"h": -0.04,
"text": "",
"style": {
"stroke": "#14a375",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 5,
"fontSize": 0.022
}
},
{
"id": "ann-bd413182-4146-448b-95f8-72630f55437d",
"type": "tooltip",
"x": 0.53,
"y": 0.13,
"w": 0.17,
"h": 0.08,
"text": "Primary action",
"style": {
"stroke": "#111827",
"fill": "#111827",
"textColor": "#ffffff",
"strokeWidth": 3,
"fontSize": 0.022,
"tail": "bottom"
}
},
{
"id": "ann-537b3971-6361-4763-8424-da8980479507",
"type": "number",
"x": 0.31,
"y": 0.08,
"w": 0.08,
"h": 0.12,
"text": "",
"style": {
"stroke": "#14a375",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 3,
"fontSize": 0.022
},
"value": 2
}
],
"textBlocks": [],
"codeBlocks": [
{
"id": "cmd",
"language": "bash",
"code": "stepforge --capture --window --delay 300"
}
],
"tableBlocks": [],
"links": []
},
{
"number": "2.1",
"kind": "empty",
"status": "todo",
"title": "Confirm permission prompt",
"descriptionHtml": "<p>Only administrators can complete this step.</p>",
"descriptionText": "Only administrators can complete this step.",
"image": null,
"annotations": [],
"textBlocks": [
{
"position": "after-description",
"level": "warn",
"title": "Access",
"descriptionHtml": "<p>Admin rights required.</p>"
}
],
"codeBlocks": [],
"tableBlocks": [],
"links": []
},
{
"number": "3",
"kind": "image",
"status": "todo",
"title": "Review the confirmation",
"descriptionHtml": "<p>Confirm the summary and close the modal.</p>",
"descriptionText": "Confirm the summary and close the modal.",
"image": {
"relPath": "steps-reset-a-password-in-admin-portal/004-review-the-confirmation.png",
"width": 1280,
"height": 760
},
"annotations": [
{
"id": "ann-281ebcd6-e0e3-4304-9232-ee25353e2321",
"type": "blur",
"x": 0.49,
"y": 0.32,
"w": 0.21,
"h": 0.08,
"text": "",
"style": {
"stroke": "#9ca3af",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 2,
"fontSize": 0.022
},
"radius": 12
},
{
"id": "ann-6224b838-a39d-4fae-9b68-6a4f2f8af60d",
"type": "highlight",
"x": 0.47,
"y": 0.24,
"w": 0.28,
"h": 0.2,
"text": "",
"style": {
"stroke": "#f0a500",
"fill": "#ffeeb0",
"textColor": "#FFFFFF",
"strokeWidth": 2,
"fontSize": 0.022
}
},
{
"id": "ann-6dd50b00-6f29-431b-bee0-c217032af1a4",
"type": "number",
"x": 0.31,
"y": 0.08,
"w": 0.08,
"h": 0.12,
"text": "",
"style": {
"stroke": "#36a",
"fill": "transparent",
"textColor": "#FFFFFF",
"strokeWidth": 3,
"fontSize": 0.022
},
"value": 3
}
],
"textBlocks": [],
"codeBlocks": [],
"tableBlocks": [
{
"id": "t1",
"rows": [
[
"Field",
"Value"
],
[
"Title",
"Admin Portal"
],
[
"Owner",
"Support"
]
]
}
],
"links": []
}
]
}