qualia-framework 2.6.0 → 3.1.0

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.
Files changed (328) hide show
  1. package/CLAUDE.md +63 -0
  2. package/README.md +108 -30
  3. package/agents/builder.md +110 -0
  4. package/agents/planner.md +186 -0
  5. package/agents/qa-browser.md +186 -0
  6. package/agents/verifier.md +369 -0
  7. package/bin/cli.js +691 -492
  8. package/bin/install.js +622 -0
  9. package/bin/qualia-ui.js +284 -0
  10. package/bin/state.js +824 -0
  11. package/bin/statusline.js +252 -0
  12. package/docs/erp-contract.md +161 -0
  13. package/guide.md +63 -0
  14. package/hooks/auto-update.js +117 -0
  15. package/hooks/block-env-edit.js +52 -0
  16. package/hooks/branch-guard.js +68 -0
  17. package/hooks/migration-guard.js +83 -0
  18. package/hooks/pre-compact.js +52 -0
  19. package/hooks/pre-deploy-gate.js +149 -0
  20. package/hooks/pre-push.js +53 -0
  21. package/hooks/session-start.js +126 -0
  22. package/package.json +30 -20
  23. package/rules/design-reference.md +179 -0
  24. package/rules/frontend.md +126 -0
  25. package/rules/infrastructure.md +87 -0
  26. package/skills/qualia/SKILL.md +88 -0
  27. package/skills/qualia-build/SKILL.md +115 -0
  28. package/skills/qualia-debug/SKILL.md +87 -0
  29. package/skills/qualia-design/SKILL.md +99 -0
  30. package/skills/qualia-handoff/SKILL.md +66 -0
  31. package/skills/qualia-help/SKILL.md +60 -0
  32. package/skills/qualia-idk/SKILL.md +8 -0
  33. package/skills/qualia-learn/SKILL.md +111 -0
  34. package/skills/qualia-new/SKILL.md +323 -0
  35. package/skills/qualia-pause/SKILL.md +63 -0
  36. package/skills/qualia-plan/SKILL.md +101 -0
  37. package/skills/qualia-polish/SKILL.md +207 -0
  38. package/skills/qualia-quick/SKILL.md +37 -0
  39. package/skills/qualia-report/SKILL.md +114 -0
  40. package/skills/qualia-resume/SKILL.md +49 -0
  41. package/skills/qualia-review/SKILL.md +161 -0
  42. package/skills/qualia-ship/SKILL.md +90 -0
  43. package/skills/qualia-skill-new/SKILL.md +167 -0
  44. package/skills/qualia-task/SKILL.md +91 -0
  45. package/skills/qualia-test/SKILL.md +134 -0
  46. package/skills/qualia-verify/SKILL.md +113 -0
  47. package/templates/DESIGN.md +475 -0
  48. package/templates/help.html +476 -0
  49. package/templates/plan.md +42 -0
  50. package/templates/project.md +22 -0
  51. package/templates/state.md +27 -0
  52. package/templates/tracking.json +20 -0
  53. package/tests/bin.test.sh +687 -0
  54. package/tests/hooks.test.sh +384 -0
  55. package/tests/runner.js +1956 -0
  56. package/tests/state.test.sh +713 -0
  57. package/tests/statusline.test.sh +243 -0
  58. package/bin/collect-metrics.sh +0 -62
  59. package/framework/.claudeignore +0 -51
  60. package/framework/CLAUDE.md +0 -51
  61. package/framework/MCP_SETUP.md +0 -229
  62. package/framework/agents/architecture-strategist.md +0 -53
  63. package/framework/agents/backend-agent.md +0 -150
  64. package/framework/agents/code-simplicity-reviewer.md +0 -86
  65. package/framework/agents/frontend-agent.md +0 -111
  66. package/framework/agents/kieran-typescript-reviewer.md +0 -96
  67. package/framework/agents/performance-oracle.md +0 -111
  68. package/framework/agents/qualia-codebase-mapper.md +0 -761
  69. package/framework/agents/qualia-debugger.md +0 -1204
  70. package/framework/agents/qualia-executor.md +0 -882
  71. package/framework/agents/qualia-integration-checker.md +0 -424
  72. package/framework/agents/qualia-phase-researcher.md +0 -457
  73. package/framework/agents/qualia-plan-checker.md +0 -700
  74. package/framework/agents/qualia-planner.md +0 -1245
  75. package/framework/agents/qualia-project-researcher.md +0 -603
  76. package/framework/agents/qualia-research-synthesizer.md +0 -200
  77. package/framework/agents/qualia-roadmapper.md +0 -606
  78. package/framework/agents/qualia-verifier.md +0 -686
  79. package/framework/agents/red-team-qa.md +0 -130
  80. package/framework/agents/security-auditor.md +0 -72
  81. package/framework/agents/team-orchestrator.md +0 -229
  82. package/framework/agents/teams/framework-audit-team.md +0 -66
  83. package/framework/agents/teams/full-stack-team.md +0 -48
  84. package/framework/agents/teams/optimize-team.md +0 -53
  85. package/framework/agents/teams/review-team.md +0 -70
  86. package/framework/agents/teams/ship-team.md +0 -86
  87. package/framework/agents/test-agent.md +0 -182
  88. package/framework/hooks/auto-format.sh +0 -54
  89. package/framework/hooks/block-env-edit.sh +0 -42
  90. package/framework/hooks/branch-guard.sh +0 -43
  91. package/framework/hooks/confirm-delete.sh +0 -59
  92. package/framework/hooks/migration-validate.sh +0 -77
  93. package/framework/hooks/notification-speak.sh +0 -16
  94. package/framework/hooks/pre-commit.sh +0 -100
  95. package/framework/hooks/pre-compact.sh +0 -56
  96. package/framework/hooks/pre-deploy-gate.sh +0 -160
  97. package/framework/hooks/qualia-colors.sh +0 -32
  98. package/framework/hooks/retention-cleanup.sh +0 -62
  99. package/framework/hooks/save-session-state.sh +0 -185
  100. package/framework/hooks/session-context-loader.sh +0 -96
  101. package/framework/hooks/session-learn.sh +0 -32
  102. package/framework/hooks/skill-announce.sh +0 -123
  103. package/framework/hooks/tool-error-announce.sh +0 -27
  104. package/framework/install.ps1 +0 -323
  105. package/framework/install.sh +0 -313
  106. package/framework/qualia-framework/VERSION +0 -1
  107. package/framework/qualia-framework/assets/qualia-logo.png +0 -0
  108. package/framework/qualia-framework/bin/collect-metrics.sh +0 -67
  109. package/framework/qualia-framework/bin/generate-report-docx.py +0 -429
  110. package/framework/qualia-framework/bin/qualia-tools.js +0 -2201
  111. package/framework/qualia-framework/bin/qualia-tools.test.js +0 -1054
  112. package/framework/qualia-framework/references/checkpoints.md +0 -775
  113. package/framework/qualia-framework/references/completion-checklists.md +0 -359
  114. package/framework/qualia-framework/references/continuation-format.md +0 -249
  115. package/framework/qualia-framework/references/continuation-prompt.md +0 -97
  116. package/framework/qualia-framework/references/decimal-phase-calculation.md +0 -65
  117. package/framework/qualia-framework/references/design-quality.md +0 -56
  118. package/framework/qualia-framework/references/employee-guide.md +0 -167
  119. package/framework/qualia-framework/references/git-integration.md +0 -254
  120. package/framework/qualia-framework/references/git-planning-commit.md +0 -50
  121. package/framework/qualia-framework/references/model-profile-resolution.md +0 -32
  122. package/framework/qualia-framework/references/model-profiles.md +0 -73
  123. package/framework/qualia-framework/references/phase-argument-parsing.md +0 -61
  124. package/framework/qualia-framework/references/planning-config.md +0 -195
  125. package/framework/qualia-framework/references/questioning.md +0 -141
  126. package/framework/qualia-framework/references/tdd.md +0 -263
  127. package/framework/qualia-framework/references/ui-brand.md +0 -160
  128. package/framework/qualia-framework/references/verification-patterns.md +0 -612
  129. package/framework/qualia-framework/templates/DEBUG.md +0 -159
  130. package/framework/qualia-framework/templates/DESIGN.md +0 -81
  131. package/framework/qualia-framework/templates/UAT.md +0 -247
  132. package/framework/qualia-framework/templates/codebase/architecture.md +0 -255
  133. package/framework/qualia-framework/templates/codebase/concerns.md +0 -310
  134. package/framework/qualia-framework/templates/codebase/conventions.md +0 -307
  135. package/framework/qualia-framework/templates/codebase/integrations.md +0 -280
  136. package/framework/qualia-framework/templates/codebase/stack.md +0 -186
  137. package/framework/qualia-framework/templates/codebase/structure.md +0 -285
  138. package/framework/qualia-framework/templates/codebase/testing.md +0 -480
  139. package/framework/qualia-framework/templates/config.json +0 -35
  140. package/framework/qualia-framework/templates/context.md +0 -283
  141. package/framework/qualia-framework/templates/continue-here.md +0 -78
  142. package/framework/qualia-framework/templates/debug-subagent-prompt.md +0 -91
  143. package/framework/qualia-framework/templates/discovery.md +0 -146
  144. package/framework/qualia-framework/templates/lab-notes.md +0 -16
  145. package/framework/qualia-framework/templates/milestone-archive.md +0 -123
  146. package/framework/qualia-framework/templates/milestone.md +0 -115
  147. package/framework/qualia-framework/templates/phase-prompt.md +0 -567
  148. package/framework/qualia-framework/templates/planner-subagent-prompt.md +0 -117
  149. package/framework/qualia-framework/templates/project.md +0 -184
  150. package/framework/qualia-framework/templates/projects/ai-agent.md +0 -156
  151. package/framework/qualia-framework/templates/projects/mobile-app.md +0 -181
  152. package/framework/qualia-framework/templates/projects/voice-agent.md +0 -134
  153. package/framework/qualia-framework/templates/projects/website.md +0 -137
  154. package/framework/qualia-framework/templates/requirements.md +0 -231
  155. package/framework/qualia-framework/templates/research-project/ARCHITECTURE.md +0 -204
  156. package/framework/qualia-framework/templates/research-project/FEATURES.md +0 -147
  157. package/framework/qualia-framework/templates/research-project/PITFALLS.md +0 -200
  158. package/framework/qualia-framework/templates/research-project/STACK.md +0 -120
  159. package/framework/qualia-framework/templates/research-project/SUMMARY.md +0 -170
  160. package/framework/qualia-framework/templates/research.md +0 -552
  161. package/framework/qualia-framework/templates/roadmap.md +0 -206
  162. package/framework/qualia-framework/templates/state.md +0 -179
  163. package/framework/qualia-framework/templates/summary-complex.md +0 -59
  164. package/framework/qualia-framework/templates/summary-minimal.md +0 -41
  165. package/framework/qualia-framework/templates/summary-standard.md +0 -48
  166. package/framework/qualia-framework/templates/summary.md +0 -246
  167. package/framework/qualia-framework/templates/user-setup.md +0 -311
  168. package/framework/qualia-framework/templates/verification-report.md +0 -322
  169. package/framework/qualia-framework/workflows/add-phase.md +0 -179
  170. package/framework/qualia-framework/workflows/add-todo.md +0 -157
  171. package/framework/qualia-framework/workflows/audit-milestone.md +0 -241
  172. package/framework/qualia-framework/workflows/check-todos.md +0 -176
  173. package/framework/qualia-framework/workflows/complete-milestone.md +0 -858
  174. package/framework/qualia-framework/workflows/diagnose-issues.md +0 -219
  175. package/framework/qualia-framework/workflows/discovery-phase.md +0 -289
  176. package/framework/qualia-framework/workflows/discuss-phase.md +0 -534
  177. package/framework/qualia-framework/workflows/execute-phase.md +0 -559
  178. package/framework/qualia-framework/workflows/execute-plan.md +0 -438
  179. package/framework/qualia-framework/workflows/help.md +0 -470
  180. package/framework/qualia-framework/workflows/insert-phase.md +0 -220
  181. package/framework/qualia-framework/workflows/list-phase-assumptions.md +0 -178
  182. package/framework/qualia-framework/workflows/map-codebase.md +0 -327
  183. package/framework/qualia-framework/workflows/new-milestone.md +0 -363
  184. package/framework/qualia-framework/workflows/new-project.md +0 -982
  185. package/framework/qualia-framework/workflows/pause-work.md +0 -122
  186. package/framework/qualia-framework/workflows/plan-milestone-gaps.md +0 -256
  187. package/framework/qualia-framework/workflows/plan-phase.md +0 -422
  188. package/framework/qualia-framework/workflows/progress.md +0 -389
  189. package/framework/qualia-framework/workflows/quick.md +0 -252
  190. package/framework/qualia-framework/workflows/remove-phase.md +0 -326
  191. package/framework/qualia-framework/workflows/research-phase.md +0 -74
  192. package/framework/qualia-framework/workflows/resume-project.md +0 -306
  193. package/framework/qualia-framework/workflows/set-profile.md +0 -80
  194. package/framework/qualia-framework/workflows/settings.md +0 -145
  195. package/framework/qualia-framework/workflows/transition.md +0 -556
  196. package/framework/qualia-framework/workflows/update.md +0 -197
  197. package/framework/qualia-framework/workflows/verify-phase.md +0 -195
  198. package/framework/qualia-framework/workflows/verify-work.md +0 -625
  199. package/framework/rules/context7.md +0 -14
  200. package/framework/rules/frontend.md +0 -33
  201. package/framework/rules/speed.md +0 -23
  202. package/framework/scripts/__pycache__/say.cpython-314.pyc +0 -0
  203. package/framework/scripts/apply-retention.sh +0 -120
  204. package/framework/scripts/bootstrap-pop-os.sh +0 -354
  205. package/framework/scripts/claude-voice +0 -13
  206. package/framework/scripts/cleanup.sh +0 -131
  207. package/framework/scripts/cowork-mode.sh +0 -141
  208. package/framework/scripts/generate-project-claude-md.sh +0 -153
  209. package/framework/scripts/load-test-webhook.js +0 -172
  210. package/framework/scripts/say.py +0 -236
  211. package/framework/scripts/showcase-video-recorder/ffmpeg-builder.js +0 -167
  212. package/framework/scripts/showcase-video-recorder/playwright-helpers.js +0 -216
  213. package/framework/scripts/speak.py +0 -55
  214. package/framework/scripts/speak.sh +0 -18
  215. package/framework/scripts/status.sh +0 -138
  216. package/framework/scripts/sync-to-framework.sh +0 -65
  217. package/framework/scripts/voice-hotkey.py +0 -227
  218. package/framework/scripts/voice-input.sh +0 -51
  219. package/framework/skills/animate/SKILL.md +0 -202
  220. package/framework/skills/bolder/SKILL.md +0 -144
  221. package/framework/skills/browser-qa/SKILL.md +0 -536
  222. package/framework/skills/clarify/SKILL.md +0 -179
  223. package/framework/skills/client-handoff/SKILL.md +0 -135
  224. package/framework/skills/collab-onboard/SKILL.md +0 -111
  225. package/framework/skills/colorize/SKILL.md +0 -170
  226. package/framework/skills/critique/SKILL.md +0 -126
  227. package/framework/skills/deep-research/SKILL.md +0 -240
  228. package/framework/skills/delight/SKILL.md +0 -329
  229. package/framework/skills/deploy/SKILL.md +0 -261
  230. package/framework/skills/deploy-verify/SKILL.md +0 -377
  231. package/framework/skills/deploy-verify/scripts/canary-check.sh +0 -206
  232. package/framework/skills/deploy-verify/scripts/check-console-errors.js +0 -147
  233. package/framework/skills/deploy-verify/scripts/check-cwv.js +0 -139
  234. package/framework/skills/deploy-verify/scripts/project-detect.sh +0 -84
  235. package/framework/skills/deploy-verify/scripts/verify.sh +0 -548
  236. package/framework/skills/design-quieter/SKILL.md +0 -130
  237. package/framework/skills/distill/SKILL.md +0 -149
  238. package/framework/skills/docs-lookup/SKILL.md +0 -79
  239. package/framework/skills/fcm-notifications/SKILL.md +0 -125
  240. package/framework/skills/financial-ledger/SKILL.md +0 -1039
  241. package/framework/skills/frontend-master/NOTICE.md +0 -4
  242. package/framework/skills/frontend-master/SKILL.md +0 -127
  243. package/framework/skills/frontend-master/reference/color-and-contrast.md +0 -132
  244. package/framework/skills/frontend-master/reference/interaction-design.md +0 -123
  245. package/framework/skills/frontend-master/reference/motion-design.md +0 -99
  246. package/framework/skills/frontend-master/reference/responsive-design.md +0 -114
  247. package/framework/skills/frontend-master/reference/spatial-design.md +0 -100
  248. package/framework/skills/frontend-master/reference/typography.md +0 -131
  249. package/framework/skills/frontend-master/reference/ux-writing.md +0 -107
  250. package/framework/skills/harden/SKILL.md +0 -357
  251. package/framework/skills/i18n-rtl/SKILL.md +0 -752
  252. package/framework/skills/learn/SKILL.md +0 -95
  253. package/framework/skills/memory/SKILL.md +0 -50
  254. package/framework/skills/mobile-expo/SKILL.md +0 -977
  255. package/framework/skills/mobile-expo/references/store-checklist.md +0 -550
  256. package/framework/skills/nestjs-backend/README.md +0 -73
  257. package/framework/skills/nestjs-backend/SKILL.md +0 -446
  258. package/framework/skills/nestjs-backend/references/templates.md +0 -1173
  259. package/framework/skills/normalize/SKILL.md +0 -79
  260. package/framework/skills/onboard/SKILL.md +0 -242
  261. package/framework/skills/openrouter-agent/SKILL.md +0 -922
  262. package/framework/skills/polish/SKILL.md +0 -209
  263. package/framework/skills/pr/SKILL.md +0 -66
  264. package/framework/skills/qualia/SKILL.md +0 -199
  265. package/framework/skills/qualia-add-todo/SKILL.md +0 -68
  266. package/framework/skills/qualia-audit-milestone/SKILL.md +0 -95
  267. package/framework/skills/qualia-check-todos/SKILL.md +0 -55
  268. package/framework/skills/qualia-complete-milestone/SKILL.md +0 -134
  269. package/framework/skills/qualia-debug/SKILL.md +0 -149
  270. package/framework/skills/qualia-design/SKILL.md +0 -203
  271. package/framework/skills/qualia-discuss-phase/SKILL.md +0 -72
  272. package/framework/skills/qualia-evolve/SKILL.md +0 -200
  273. package/framework/skills/qualia-execute-phase/SKILL.md +0 -89
  274. package/framework/skills/qualia-framework-audit/SKILL.md +0 -604
  275. package/framework/skills/qualia-guide/SKILL.md +0 -32
  276. package/framework/skills/qualia-help/SKILL.md +0 -114
  277. package/framework/skills/qualia-idk/SKILL.md +0 -352
  278. package/framework/skills/qualia-list-phase-assumptions/SKILL.md +0 -67
  279. package/framework/skills/qualia-new-milestone/SKILL.md +0 -72
  280. package/framework/skills/qualia-new-project/SKILL.md +0 -232
  281. package/framework/skills/qualia-optimize/SKILL.md +0 -417
  282. package/framework/skills/qualia-pause-work/SKILL.md +0 -96
  283. package/framework/skills/qualia-plan-milestone-gaps/SKILL.md +0 -57
  284. package/framework/skills/qualia-plan-phase/SKILL.md +0 -104
  285. package/framework/skills/qualia-production-check/SKILL.md +0 -0
  286. package/framework/skills/qualia-progress/SKILL.md +0 -53
  287. package/framework/skills/qualia-quick/SKILL.md +0 -89
  288. package/framework/skills/qualia-report/SKILL.md +0 -166
  289. package/framework/skills/qualia-research-phase/SKILL.md +0 -88
  290. package/framework/skills/qualia-resume-work/SKILL.md +0 -62
  291. package/framework/skills/qualia-review/SKILL.md +0 -263
  292. package/framework/skills/qualia-start/SKILL.md +0 -161
  293. package/framework/skills/qualia-verify-work/SKILL.md +0 -132
  294. package/framework/skills/rag/SKILL.md +0 -750
  295. package/framework/skills/responsive/SKILL.md +0 -231
  296. package/framework/skills/retro/SKILL.md +0 -284
  297. package/framework/skills/sakani-conventions/SKILL.md +0 -136
  298. package/framework/skills/sakani-conventions/evals/evals.json +0 -23
  299. package/framework/skills/sakani-conventions/references/entities.md +0 -365
  300. package/framework/skills/sakani-conventions/references/error-codes.md +0 -95
  301. package/framework/skills/seo-master/SKILL.md +0 -490
  302. package/framework/skills/seo-master/references/checklist.md +0 -199
  303. package/framework/skills/seo-master/references/structured-data.md +0 -609
  304. package/framework/skills/ship/SKILL.md +0 -239
  305. package/framework/skills/stack-researcher/SKILL.md +0 -215
  306. package/framework/skills/status/SKILL.md +0 -154
  307. package/framework/skills/status/scripts/health-check.sh +0 -562
  308. package/framework/skills/subscription-payments/SKILL.md +0 -250
  309. package/framework/skills/supabase/SKILL.md +0 -973
  310. package/framework/skills/supabase/references/templates.md +0 -159
  311. package/framework/skills/team/SKILL.md +0 -67
  312. package/framework/skills/test-runner/SKILL.md +0 -202
  313. package/framework/skills/voice-agent/SKILL.md +0 -1312
  314. package/framework/skills/zoho-workflow/SKILL.md +0 -51
  315. package/framework/statusline-command.sh +0 -117
  316. package/framework/teams/default/inboxes/plan-04.json +0 -9
  317. package/framework/teams/review-team.md +0 -75
  318. package/framework/teams/ship-team.md +0 -86
  319. package/profiles/fawzi.json +0 -16
  320. package/profiles/hasan.json +0 -16
  321. package/profiles/moayad.json +0 -16
  322. package/templates/CLAUDE-owner.md +0 -52
  323. package/templates/CLAUDE.md.hbs +0 -58
  324. package/templates/env.claude.template +0 -12
  325. package/templates/settings.json +0 -172
  326. package/uninstall.sh +0 -90
  327. /package/{framework/rules → rules}/deployment.md +0 -0
  328. /package/{framework/rules → rules}/security.md +0 -0
@@ -1,609 +0,0 @@
1
- # Structured Data Templates (JSON-LD)
2
-
3
- Complete, validated JSON-LD templates for every common schema type. Copy and adapt these — fill in bracketed values with real data from the page.
4
-
5
- ## Table of Contents
6
-
7
- 1. [Organization](#organization)
8
- 2. [WebSite with SearchAction](#website-with-searchaction)
9
- 3. [LocalBusiness](#localbusiness)
10
- 4. [Service](#service)
11
- 5. [Product](#product)
12
- 6. [Article / BlogPosting](#article--blogposting)
13
- 7. [FAQPage](#faqpage)
14
- 8. [HowTo](#howto)
15
- 9. [BreadcrumbList](#breadcrumblist)
16
- 10. [Person](#person)
17
- 11. [Event](#event)
18
- 12. [VideoObject](#videoobject)
19
- 13. [SoftwareApplication](#softwareapplication)
20
- 14. [ContactPoint](#contactpoint)
21
- 15. [AggregateRating / Review](#aggregaterating--review)
22
- 16. [Course](#course)
23
- 17. [Recipe](#recipe)
24
- 18. [JobPosting](#jobposting)
25
-
26
- ---
27
-
28
- ## Organization
29
-
30
- Use on: Homepage, About page
31
-
32
- ```json
33
- {
34
- "@context": "https://schema.org",
35
- "@type": "Organization",
36
- "name": "[Company Name]",
37
- "url": "[https://example.com]",
38
- "logo": "[https://example.com/logo.png]",
39
- "description": "[Brief company description]",
40
- "foundingDate": "[YYYY]",
41
- "founder": {
42
- "@type": "Person",
43
- "name": "[Founder Name]"
44
- },
45
- "address": {
46
- "@type": "PostalAddress",
47
- "streetAddress": "[Street]",
48
- "addressLocality": "[City]",
49
- "addressRegion": "[State/Region]",
50
- "postalCode": "[Postal Code]",
51
- "addressCountry": "[Country Code]"
52
- },
53
- "contactPoint": {
54
- "@type": "ContactPoint",
55
- "telephone": "[+1-xxx-xxx-xxxx]",
56
- "contactType": "customer service",
57
- "email": "[email@example.com]"
58
- },
59
- "sameAs": [
60
- "[https://linkedin.com/company/xxx]",
61
- "[https://twitter.com/xxx]",
62
- "[https://github.com/xxx]"
63
- ]
64
- }
65
- ```
66
-
67
- ## WebSite with SearchAction
68
-
69
- Use on: Homepage (enables sitelinks search box in Google)
70
-
71
- ```json
72
- {
73
- "@context": "https://schema.org",
74
- "@type": "WebSite",
75
- "name": "[Site Name]",
76
- "url": "[https://example.com]",
77
- "potentialAction": {
78
- "@type": "SearchAction",
79
- "target": {
80
- "@type": "EntryPoint",
81
- "urlTemplate": "[https://example.com/search?q={search_term_string}]"
82
- },
83
- "query-input": "required name=search_term_string"
84
- }
85
- }
86
- ```
87
-
88
- ## LocalBusiness
89
-
90
- Use on: Homepage, Contact page (for businesses with physical locations)
91
-
92
- ```json
93
- {
94
- "@context": "https://schema.org",
95
- "@type": "LocalBusiness",
96
- "name": "[Business Name]",
97
- "url": "[https://example.com]",
98
- "telephone": "[+1-xxx-xxx-xxxx]",
99
- "email": "[email@example.com]",
100
- "address": {
101
- "@type": "PostalAddress",
102
- "streetAddress": "[Street Address]",
103
- "addressLocality": "[City]",
104
- "addressRegion": "[State/Region]",
105
- "postalCode": "[Postal Code]",
106
- "addressCountry": "[Country Code]"
107
- },
108
- "geo": {
109
- "@type": "GeoCoordinates",
110
- "latitude": "[XX.XXXXX]",
111
- "longitude": "[XX.XXXXX]"
112
- },
113
- "openingHoursSpecification": [
114
- {
115
- "@type": "OpeningHoursSpecification",
116
- "dayOfWeek": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"],
117
- "opens": "09:00",
118
- "closes": "17:00"
119
- }
120
- ],
121
- "priceRange": "[$$ or description]",
122
- "image": "[https://example.com/storefront.jpg]",
123
- "sameAs": ["[social media URLs]"]
124
- }
125
- ```
126
-
127
- ## Service
128
-
129
- Use on: Service/offering pages
130
-
131
- ```json
132
- {
133
- "@context": "https://schema.org",
134
- "@type": "Service",
135
- "name": "[Service Name]",
136
- "description": "[Service description, 150-300 chars]",
137
- "provider": {
138
- "@type": "Organization",
139
- "name": "[Company Name]",
140
- "url": "[https://example.com]"
141
- },
142
- "serviceType": "[Category of service]",
143
- "areaServed": {
144
- "@type": "Place",
145
- "name": "[City, Country or worldwide]"
146
- },
147
- "hasOfferCatalog": {
148
- "@type": "OfferCatalog",
149
- "name": "[Catalog Name]",
150
- "itemListElement": [
151
- {
152
- "@type": "Offer",
153
- "itemOffered": {
154
- "@type": "Service",
155
- "name": "[Sub-service Name]",
156
- "description": "[Brief description]"
157
- }
158
- }
159
- ]
160
- }
161
- }
162
- ```
163
-
164
- ## Product
165
-
166
- Use on: Product pages, e-commerce
167
-
168
- ```json
169
- {
170
- "@context": "https://schema.org",
171
- "@type": "Product",
172
- "name": "[Product Name]",
173
- "description": "[Product description]",
174
- "image": ["[https://example.com/product1.jpg]"],
175
- "sku": "[SKU]",
176
- "brand": {
177
- "@type": "Brand",
178
- "name": "[Brand Name]"
179
- },
180
- "offers": {
181
- "@type": "Offer",
182
- "url": "[https://example.com/product]",
183
- "priceCurrency": "[USD]",
184
- "price": "[29.99]",
185
- "availability": "https://schema.org/InStock",
186
- "seller": {
187
- "@type": "Organization",
188
- "name": "[Seller Name]"
189
- }
190
- },
191
- "aggregateRating": {
192
- "@type": "AggregateRating",
193
- "ratingValue": "[4.5]",
194
- "reviewCount": "[89]"
195
- }
196
- }
197
- ```
198
-
199
- ## Article / BlogPosting
200
-
201
- Use on: Blog posts, articles, news
202
-
203
- ```json
204
- {
205
- "@context": "https://schema.org",
206
- "@type": "BlogPosting",
207
- "headline": "[Article Title — max 110 chars]",
208
- "description": "[Article description — 150-160 chars]",
209
- "image": "[https://example.com/article-image.jpg]",
210
- "datePublished": "[YYYY-MM-DD]",
211
- "dateModified": "[YYYY-MM-DD]",
212
- "author": {
213
- "@type": "Person",
214
- "name": "[Author Name]",
215
- "url": "[https://example.com/about]"
216
- },
217
- "publisher": {
218
- "@type": "Organization",
219
- "name": "[Publisher Name]",
220
- "logo": {
221
- "@type": "ImageObject",
222
- "url": "[https://example.com/logo.png]"
223
- }
224
- },
225
- "mainEntityOfPage": {
226
- "@type": "WebPage",
227
- "@id": "[https://example.com/blog/slug]"
228
- },
229
- "wordCount": "[1500]",
230
- "keywords": "[keyword1, keyword2, keyword3]"
231
- }
232
- ```
233
-
234
- ## FAQPage
235
-
236
- Use on: Any page with FAQ section
237
-
238
- ```json
239
- {
240
- "@context": "https://schema.org",
241
- "@type": "FAQPage",
242
- "mainEntity": [
243
- {
244
- "@type": "Question",
245
- "name": "[Question text?]",
246
- "acceptedAnswer": {
247
- "@type": "Answer",
248
- "text": "[Answer text. Can include <a href='url'>links</a> in HTML.]"
249
- }
250
- },
251
- {
252
- "@type": "Question",
253
- "name": "[Another question?]",
254
- "acceptedAnswer": {
255
- "@type": "Answer",
256
- "text": "[Another answer.]"
257
- }
258
- }
259
- ]
260
- }
261
- ```
262
-
263
- ## HowTo
264
-
265
- Use on: Tutorial or process pages
266
-
267
- ```json
268
- {
269
- "@context": "https://schema.org",
270
- "@type": "HowTo",
271
- "name": "[How to Do X]",
272
- "description": "[Brief description of the process]",
273
- "totalTime": "PT[X]M",
274
- "estimatedCost": {
275
- "@type": "MonetaryAmount",
276
- "currency": "USD",
277
- "value": "[0 or cost]"
278
- },
279
- "step": [
280
- {
281
- "@type": "HowToStep",
282
- "name": "[Step 1 Title]",
283
- "text": "[Step 1 description]",
284
- "url": "[https://example.com/guide#step1]",
285
- "image": "[https://example.com/step1.jpg]"
286
- },
287
- {
288
- "@type": "HowToStep",
289
- "name": "[Step 2 Title]",
290
- "text": "[Step 2 description]"
291
- }
292
- ]
293
- }
294
- ```
295
-
296
- ## BreadcrumbList
297
-
298
- Use on: All pages (helps Google understand site hierarchy)
299
-
300
- ```json
301
- {
302
- "@context": "https://schema.org",
303
- "@type": "BreadcrumbList",
304
- "itemListElement": [
305
- {
306
- "@type": "ListItem",
307
- "position": 1,
308
- "name": "Home",
309
- "item": "[https://example.com]"
310
- },
311
- {
312
- "@type": "ListItem",
313
- "position": 2,
314
- "name": "[Category]",
315
- "item": "[https://example.com/category]"
316
- },
317
- {
318
- "@type": "ListItem",
319
- "position": 3,
320
- "name": "[Current Page]",
321
- "item": "[https://example.com/category/page]"
322
- }
323
- ]
324
- }
325
- ```
326
-
327
- ## Person
328
-
329
- Use on: About page, team page, author pages
330
-
331
- ```json
332
- {
333
- "@context": "https://schema.org",
334
- "@type": "Person",
335
- "name": "[Full Name]",
336
- "jobTitle": "[Job Title]",
337
- "worksFor": {
338
- "@type": "Organization",
339
- "name": "[Company Name]"
340
- },
341
- "url": "[https://example.com/about]",
342
- "image": "[https://example.com/headshot.jpg]",
343
- "sameAs": [
344
- "[https://linkedin.com/in/xxx]",
345
- "[https://twitter.com/xxx]"
346
- ],
347
- "knowsAbout": ["[Skill 1]", "[Skill 2]", "[Skill 3]"]
348
- }
349
- ```
350
-
351
- ## Event
352
-
353
- Use on: Event pages, webinar pages
354
-
355
- ```json
356
- {
357
- "@context": "https://schema.org",
358
- "@type": "Event",
359
- "name": "[Event Name]",
360
- "description": "[Event description]",
361
- "startDate": "[YYYY-MM-DDTHH:MM:SS+00:00]",
362
- "endDate": "[YYYY-MM-DDTHH:MM:SS+00:00]",
363
- "eventStatus": "https://schema.org/EventScheduled",
364
- "eventAttendanceMode": "https://schema.org/OnlineEventAttendanceMode",
365
- "location": {
366
- "@type": "VirtualLocation",
367
- "url": "[https://example.com/event]"
368
- },
369
- "organizer": {
370
- "@type": "Organization",
371
- "name": "[Organizer Name]",
372
- "url": "[https://example.com]"
373
- },
374
- "offers": {
375
- "@type": "Offer",
376
- "price": "[0]",
377
- "priceCurrency": "USD",
378
- "availability": "https://schema.org/InStock",
379
- "url": "[https://example.com/register]"
380
- }
381
- }
382
- ```
383
-
384
- ## VideoObject
385
-
386
- Use on: Pages with embedded video content
387
-
388
- ```json
389
- {
390
- "@context": "https://schema.org",
391
- "@type": "VideoObject",
392
- "name": "[Video Title]",
393
- "description": "[Video description]",
394
- "thumbnailUrl": "[https://example.com/thumbnail.jpg]",
395
- "uploadDate": "[YYYY-MM-DD]",
396
- "duration": "PT[X]M[Y]S",
397
- "contentUrl": "[https://example.com/video.mp4]",
398
- "embedUrl": "[https://youtube.com/embed/xxx]",
399
- "publisher": {
400
- "@type": "Organization",
401
- "name": "[Publisher Name]",
402
- "logo": {
403
- "@type": "ImageObject",
404
- "url": "[https://example.com/logo.png]"
405
- }
406
- }
407
- }
408
- ```
409
-
410
- ## SoftwareApplication
411
-
412
- Use on: SaaS product pages, app landing pages
413
-
414
- ```json
415
- {
416
- "@context": "https://schema.org",
417
- "@type": "SoftwareApplication",
418
- "name": "[App Name]",
419
- "description": "[App description]",
420
- "applicationCategory": "BusinessApplication",
421
- "operatingSystem": "Web",
422
- "url": "[https://example.com]",
423
- "offers": {
424
- "@type": "Offer",
425
- "price": "[0]",
426
- "priceCurrency": "USD"
427
- },
428
- "aggregateRating": {
429
- "@type": "AggregateRating",
430
- "ratingValue": "[4.5]",
431
- "ratingCount": "[100]"
432
- }
433
- }
434
- ```
435
-
436
- ## ContactPoint
437
-
438
- Use alongside Organization schema
439
-
440
- ```json
441
- {
442
- "@type": "ContactPoint",
443
- "telephone": "[+1-xxx-xxx-xxxx]",
444
- "contactType": "customer service",
445
- "email": "[email@example.com]",
446
- "availableLanguage": ["English", "Arabic"],
447
- "contactOption": "TollFree",
448
- "areaServed": "[Country or region]"
449
- }
450
- ```
451
-
452
- ## AggregateRating / Review
453
-
454
- Nest inside Product, LocalBusiness, or Organization
455
-
456
- ```json
457
- {
458
- "aggregateRating": {
459
- "@type": "AggregateRating",
460
- "ratingValue": "[4.8]",
461
- "bestRating": "5",
462
- "worstRating": "1",
463
- "ratingCount": "[150]",
464
- "reviewCount": "[45]"
465
- },
466
- "review": [
467
- {
468
- "@type": "Review",
469
- "author": {
470
- "@type": "Person",
471
- "name": "[Reviewer Name]"
472
- },
473
- "datePublished": "[YYYY-MM-DD]",
474
- "reviewRating": {
475
- "@type": "Rating",
476
- "ratingValue": "[5]"
477
- },
478
- "reviewBody": "[Review text]"
479
- }
480
- ]
481
- }
482
- ```
483
-
484
- ## Course
485
-
486
- Use on: Course/training pages
487
-
488
- ```json
489
- {
490
- "@context": "https://schema.org",
491
- "@type": "Course",
492
- "name": "[Course Title]",
493
- "description": "[Course description]",
494
- "provider": {
495
- "@type": "Organization",
496
- "name": "[Provider Name]",
497
- "url": "[https://example.com]"
498
- },
499
- "courseCode": "[COURSE-101]",
500
- "hasCourseInstance": {
501
- "@type": "CourseInstance",
502
- "courseMode": "online",
503
- "courseSchedule": {
504
- "@type": "Schedule",
505
- "repeatFrequency": "P1W"
506
- }
507
- }
508
- }
509
- ```
510
-
511
- ## Recipe
512
-
513
- Use on: Recipe pages
514
-
515
- ```json
516
- {
517
- "@context": "https://schema.org",
518
- "@type": "Recipe",
519
- "name": "[Recipe Name]",
520
- "description": "[Recipe description]",
521
- "image": ["[https://example.com/dish.jpg]"],
522
- "author": {
523
- "@type": "Person",
524
- "name": "[Chef Name]"
525
- },
526
- "datePublished": "[YYYY-MM-DD]",
527
- "prepTime": "PT[X]M",
528
- "cookTime": "PT[X]M",
529
- "totalTime": "PT[X]M",
530
- "recipeYield": "[4 servings]",
531
- "recipeCategory": "[Dinner]",
532
- "recipeCuisine": "[Italian]",
533
- "recipeIngredient": [
534
- "[2 cups flour]",
535
- "[1 cup sugar]"
536
- ],
537
- "recipeInstructions": [
538
- {
539
- "@type": "HowToStep",
540
- "text": "[Step 1 instructions]"
541
- }
542
- ],
543
- "nutrition": {
544
- "@type": "NutritionInformation",
545
- "calories": "[250 calories]"
546
- }
547
- }
548
- ```
549
-
550
- ## JobPosting
551
-
552
- Use on: Career/job listing pages
553
-
554
- ```json
555
- {
556
- "@context": "https://schema.org",
557
- "@type": "JobPosting",
558
- "title": "[Job Title]",
559
- "description": "[Full job description in HTML]",
560
- "datePosted": "[YYYY-MM-DD]",
561
- "validThrough": "[YYYY-MM-DD]",
562
- "employmentType": "FULL_TIME",
563
- "hiringOrganization": {
564
- "@type": "Organization",
565
- "name": "[Company Name]",
566
- "sameAs": "[https://example.com]",
567
- "logo": "[https://example.com/logo.png]"
568
- },
569
- "jobLocation": {
570
- "@type": "Place",
571
- "address": {
572
- "@type": "PostalAddress",
573
- "addressLocality": "[City]",
574
- "addressRegion": "[State]",
575
- "addressCountry": "[Country]"
576
- }
577
- },
578
- "baseSalary": {
579
- "@type": "MonetaryAmount",
580
- "currency": "USD",
581
- "value": {
582
- "@type": "QuantitativeValue",
583
- "minValue": "[50000]",
584
- "maxValue": "[80000]",
585
- "unitText": "YEAR"
586
- }
587
- },
588
- "applicantLocationRequirements": {
589
- "@type": "Country",
590
- "name": "[Country]"
591
- },
592
- "jobLocationType": "TELECOMMUTE"
593
- }
594
- ```
595
-
596
- ---
597
-
598
- ## Validation Rules
599
-
600
- When generating or reviewing structured data, verify:
601
-
602
- 1. **@context** is exactly `"https://schema.org"` (not http, not schema.org without protocol)
603
- 2. **Required fields** are present per type (Google's rich result requirements)
604
- 3. **No invisible content** — structured data must match what users see on the page
605
- 4. **Valid URLs** — all url/image fields use absolute HTTPS URLs
606
- 5. **Valid dates** — ISO 8601 format (YYYY-MM-DD or full datetime)
607
- 6. **No deprecated types** — avoid types Google has dropped support for
608
- 7. **Nesting** — prefer @type nesting over flat @id references for simplicity
609
- 8. **One script per type** — use separate `<script type="application/ld+json">` blocks for unrelated types