@riverbankcms/sdk 0.129.0 → 0.129.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.
Files changed (260) hide show
  1. package/README.md +19 -256
  2. package/dist/{PreviewEditorSidebar-B43CJ0g_.mjs → PreviewEditorSidebar-DceRseRV.mjs} +3 -3
  3. package/dist/{PreviewEditorUI-DHirVkeM.mjs → PreviewEditorUI-BNunq3kk.mjs} +2 -2
  4. package/dist/{SdkPreviewModeRuntime-BJumZy1B.mjs → SdkPreviewModeRuntime-Bt87-62u.mjs} +3 -3
  5. package/dist/{SiteChromeCustomizeContext-D9SlpwEj.mjs → SiteChromeCustomizeContext-BLl-OlL4.mjs} +460 -393
  6. package/dist/_dts/ai/src/contracts/commandExposure.d.ts +1 -1
  7. package/dist/_dts/ai/src/contracts/proposals.d.ts +4897 -4897
  8. package/dist/_dts/api/src/index.d.ts +2 -1
  9. package/dist/_dts/api/src/sdk-event-management.d.ts +53 -0
  10. package/dist/_dts/api/src/sdk-event-schedule.d.ts +3 -6
  11. package/dist/_dts/api/src/sdkContracts.d.ts +37 -50
  12. package/dist/_dts/api/src/sdkThemeWire.d.ts +2595 -0
  13. package/dist/_dts/api/src/sitePlatformEndpoints.d.ts +13 -29
  14. package/dist/_dts/media-core/src/index.d.ts +1 -0
  15. package/dist/_dts/sdk/src/config/types.d.ts +4 -4
  16. package/dist/_dts/sdk/src/version.d.ts +1 -1
  17. package/dist/_dts/theme-core/src/buttons/index.d.ts +1 -0
  18. package/dist/_dts/theme-core/src/palette/index.d.ts +1 -0
  19. package/dist/_dts/theme-core/src/site-styles/headerLayoutStyleCatalog.d.ts +254 -0
  20. package/dist/_dts/theme-core/src/site-styles/headerLegacyLooks.d.ts +372 -0
  21. package/dist/_dts/theme-core/src/site-styles/headerLookBranding.d.ts +106 -0
  22. package/dist/_dts/theme-core/src/site-styles/headerLookSelection.d.ts +2 -0
  23. package/dist/_dts/theme-core/src/site-styles/headerLookTypes.d.ts +212 -0
  24. package/dist/_dts/theme-core/src/site-styles/headerLooks.d.ts +7 -841
  25. package/dist/_dts/theme-core/src/site-styles/headerStyleCompiler.d.ts +3 -0
  26. package/dist/_dts/theme-core/src/site-styles/headerStyleCompilerPrimitives.d.ts +23 -0
  27. package/dist/client/client.mjs +492 -426
  28. package/dist/client/hooks.mjs +59 -36
  29. package/dist/client/rendering/client.mjs +593 -547
  30. package/dist/client/rendering.mjs +491 -425
  31. package/dist/preview-next/client/runtime.mjs +3 -3
  32. package/dist/{sdk-runtime-CfZd5pAm.mjs → sdk-runtime-C20CVWbb.mjs} +1 -1
  33. package/dist/{separator-DkTe68HE.mjs → separator-BE3NCquy.mjs} +1 -1
  34. package/dist/server/components.mjs +72 -49
  35. package/dist/server/config-validation.mjs +59 -36
  36. package/dist/server/config.mjs +59 -36
  37. package/dist/server/data.mjs +59 -36
  38. package/dist/server/index.mjs +1 -1
  39. package/dist/server/manifest.mjs +4966 -0
  40. package/dist/server/next.mjs +73 -50
  41. package/dist/server/page-converter.mjs +40 -36
  42. package/dist/server/prebuild.mjs +1 -1
  43. package/dist/server/rendering/server.mjs +72 -49
  44. package/dist/server/rendering.mjs +72 -49
  45. package/dist/server/routing.mjs +472 -402
  46. package/dist/server/server.mjs +60 -37
  47. package/dist/server/theme-bridge.mjs +70 -66
  48. package/package.json +9 -12
  49. package/dist/_dts/api/src/event-presentation.d.ts +0 -14
  50. package/dist/_dts/blocks/src/definitions.d.ts +0 -14
  51. package/dist/_dts/sdk/src/cli/canonical-entry-policy.d.ts +0 -53
  52. package/dist/_dts/sdk/src/cli/commands/audit.d.ts +0 -101
  53. package/dist/_dts/sdk/src/cli/commands/block.d.ts +0 -24
  54. package/dist/_dts/sdk/src/cli/commands/compare.d.ts +0 -62
  55. package/dist/_dts/sdk/src/cli/commands/content-type.d.ts +0 -10
  56. package/dist/_dts/sdk/src/cli/commands/content.d.ts +0 -56
  57. package/dist/_dts/sdk/src/cli/commands/delete.d.ts +0 -14
  58. package/dist/_dts/sdk/src/cli/commands/deploy.d.ts +0 -43
  59. package/dist/_dts/sdk/src/cli/commands/drafts.d.ts +0 -18
  60. package/dist/_dts/sdk/src/cli/commands/entry.d.ts +0 -55
  61. package/dist/_dts/sdk/src/cli/commands/env.d.ts +0 -31
  62. package/dist/_dts/sdk/src/cli/commands/event.d.ts +0 -23
  63. package/dist/_dts/sdk/src/cli/commands/eventOccurrenceSchedule.d.ts +0 -12
  64. package/dist/_dts/sdk/src/cli/commands/identifiers.d.ts +0 -10
  65. package/dist/_dts/sdk/src/cli/commands/init-docs.d.ts +0 -13
  66. package/dist/_dts/sdk/src/cli/commands/manifest.d.ts +0 -10
  67. package/dist/_dts/sdk/src/cli/commands/media-validation.d.ts +0 -3
  68. package/dist/_dts/sdk/src/cli/commands/migrate.d.ts +0 -11
  69. package/dist/_dts/sdk/src/cli/commands/navigation.d.ts +0 -12
  70. package/dist/_dts/sdk/src/cli/commands/page.d.ts +0 -14
  71. package/dist/_dts/sdk/src/cli/commands/publish-all.d.ts +0 -50
  72. package/dist/_dts/sdk/src/cli/commands/pull-dated-offering-scope.d.ts +0 -10
  73. package/dist/_dts/sdk/src/cli/commands/pull-dry-run.d.ts +0 -70
  74. package/dist/_dts/sdk/src/cli/commands/pull-scope-diff.d.ts +0 -8
  75. package/dist/_dts/sdk/src/cli/commands/pull.d.ts +0 -43
  76. package/dist/_dts/sdk/src/cli/commands/push/consts.d.ts +0 -3
  77. package/dist/_dts/sdk/src/cli/commands/push/execute/diff.d.ts +0 -19
  78. package/dist/_dts/sdk/src/cli/commands/push/execute/footer.d.ts +0 -42
  79. package/dist/_dts/sdk/src/cli/commands/push/execute/localMediaReporting.d.ts +0 -23
  80. package/dist/_dts/sdk/src/cli/commands/push/execute/media.d.ts +0 -22
  81. package/dist/_dts/sdk/src/cli/commands/push/execute/metadata.d.ts +0 -1
  82. package/dist/_dts/sdk/src/cli/commands/push/execute/reporting.d.ts +0 -7
  83. package/dist/_dts/sdk/src/cli/commands/push/execute/theme.d.ts +0 -63
  84. package/dist/_dts/sdk/src/cli/commands/push/filter.d.ts +0 -15
  85. package/dist/_dts/sdk/src/cli/commands/push/metadata.d.ts +0 -29
  86. package/dist/_dts/sdk/src/cli/commands/push/normalizeLocalContent.d.ts +0 -2
  87. package/dist/_dts/sdk/src/cli/commands/push/options.d.ts +0 -32
  88. package/dist/_dts/sdk/src/cli/commands/push/publishGuidance.d.ts +0 -15
  89. package/dist/_dts/sdk/src/cli/commands/push/pushAllExtras.d.ts +0 -25
  90. package/dist/_dts/sdk/src/cli/commands/push/scopes/commandBackedDatedOfferingScope.d.ts +0 -83
  91. package/dist/_dts/sdk/src/cli/commands/push/scopes/eventCategories.d.ts +0 -4
  92. package/dist/_dts/sdk/src/cli/commands/push/scopes/events.d.ts +0 -4
  93. package/dist/_dts/sdk/src/cli/commands/push/scopes/mediaPrep.d.ts +0 -14
  94. package/dist/_dts/sdk/src/cli/commands/push/scopes/pushScopeGeneric.d.ts +0 -6
  95. package/dist/_dts/sdk/src/cli/commands/push/scopes/types.d.ts +0 -87
  96. package/dist/_dts/sdk/src/cli/commands/push/scopes/venues.d.ts +0 -4
  97. package/dist/_dts/sdk/src/cli/commands/push/stale-resolution.d.ts +0 -48
  98. package/dist/_dts/sdk/src/cli/commands/push/stale.d.ts +0 -17
  99. package/dist/_dts/sdk/src/cli/commands/push/verification.d.ts +0 -56
  100. package/dist/_dts/sdk/src/cli/commands/push/workflowPlan.d.ts +0 -34
  101. package/dist/_dts/sdk/src/cli/commands/push-execute.d.ts +0 -54
  102. package/dist/_dts/sdk/src/cli/commands/push.d.ts +0 -40
  103. package/dist/_dts/sdk/src/cli/commands/setup.d.ts +0 -3
  104. package/dist/_dts/sdk/src/cli/commands/style.d.ts +0 -60
  105. package/dist/_dts/sdk/src/cli/commands/verify.d.ts +0 -11
  106. package/dist/_dts/sdk/src/cli/commands/webhooks.d.ts +0 -44
  107. package/dist/_dts/sdk/src/cli/config-loader.d.ts +0 -47
  108. package/dist/_dts/sdk/src/cli/content/collectionWriters.d.ts +0 -23
  109. package/dist/_dts/sdk/src/cli/content/edit/format.d.ts +0 -2
  110. package/dist/_dts/sdk/src/cli/content/edit/path.d.ts +0 -14
  111. package/dist/_dts/sdk/src/cli/content/edit/planner.d.ts +0 -46
  112. package/dist/_dts/sdk/src/cli/content/entryPaths.d.ts +0 -6
  113. package/dist/_dts/sdk/src/cli/content/footerFile.d.ts +0 -10
  114. package/dist/_dts/sdk/src/cli/content/fs-utils.d.ts +0 -39
  115. package/dist/_dts/sdk/src/cli/content/legacyEventScheduleShapeError.d.ts +0 -5
  116. package/dist/_dts/sdk/src/cli/content/localEventSchedule.d.ts +0 -17
  117. package/dist/_dts/sdk/src/cli/content/media-manifest.d.ts +0 -13
  118. package/dist/_dts/sdk/src/cli/content/metadataAfterPush.d.ts +0 -25
  119. package/dist/_dts/sdk/src/cli/content/metadataStore.d.ts +0 -29
  120. package/dist/_dts/sdk/src/cli/content/reader.d.ts +0 -488
  121. package/dist/_dts/sdk/src/cli/content/writer.d.ts +0 -142
  122. package/dist/_dts/sdk/src/cli/env-scope.d.ts +0 -2
  123. package/dist/_dts/sdk/src/cli/env.d.ts +0 -71
  124. package/dist/_dts/sdk/src/cli/errors.d.ts +0 -62
  125. package/dist/_dts/sdk/src/cli/helpers/ai-runtime.d.ts +0 -2
  126. package/dist/_dts/sdk/src/cli/helpers.d.ts +0 -399
  127. package/dist/_dts/sdk/src/cli/index.d.ts +0 -11
  128. package/dist/_dts/sdk/src/cli/init-docs/constants.d.ts +0 -16
  129. package/dist/_dts/sdk/src/cli/init-docs/index.d.ts +0 -12
  130. package/dist/_dts/sdk/src/cli/init-docs/templates.d.ts +0 -18
  131. package/dist/_dts/sdk/src/cli/init-docs/zod-to-markdown.d.ts +0 -28
  132. package/dist/_dts/sdk/src/cli/load-config.d.ts +0 -14
  133. package/dist/_dts/sdk/src/cli/media/identifiers.d.ts +0 -18
  134. package/dist/_dts/sdk/src/cli/media/local-media.d.ts +0 -14
  135. package/dist/_dts/sdk/src/cli/media/local-sync.d.ts +0 -91
  136. package/dist/_dts/sdk/src/cli/media/portable.d.ts +0 -11
  137. package/dist/_dts/sdk/src/cli/media/rich-text.d.ts +0 -12
  138. package/dist/_dts/sdk/src/cli/media/value-utils.d.ts +0 -15
  139. package/dist/_dts/sdk/src/cli/media/write-guard.d.ts +0 -52
  140. package/dist/_dts/sdk/src/cli/merge-remote/entryLocal.d.ts +0 -3
  141. package/dist/_dts/sdk/src/cli/merge-remote/entryMerge.d.ts +0 -78
  142. package/dist/_dts/sdk/src/cli/merge-remote/entryMergePlan.d.ts +0 -45
  143. package/dist/_dts/sdk/src/cli/merge-remote/entryMergePush.d.ts +0 -24
  144. package/dist/_dts/sdk/src/cli/merge-remote/entryMergeReport.d.ts +0 -18
  145. package/dist/_dts/sdk/src/cli/merge-remote/entryRemote.d.ts +0 -9
  146. package/dist/_dts/sdk/src/cli/merge-remote/entrySnapshots.d.ts +0 -48
  147. package/dist/_dts/sdk/src/cli/merge-remote/mergeFieldChanges.d.ts +0 -22
  148. package/dist/_dts/sdk/src/cli/merge-remote/pageLocal.d.ts +0 -3
  149. package/dist/_dts/sdk/src/cli/merge-remote/pageMerge.d.ts +0 -78
  150. package/dist/_dts/sdk/src/cli/merge-remote/pageMergePlan.d.ts +0 -36
  151. package/dist/_dts/sdk/src/cli/merge-remote/pageMergePush.d.ts +0 -23
  152. package/dist/_dts/sdk/src/cli/merge-remote/pageMergeReport.d.ts +0 -17
  153. package/dist/_dts/sdk/src/cli/merge-remote/pageSnapshots.d.ts +0 -46
  154. package/dist/_dts/sdk/src/cli/merge-remote/sharedBaseSnapshots.d.ts +0 -32
  155. package/dist/_dts/sdk/src/cli/merge-remote/sharedMergePlan.d.ts +0 -27
  156. package/dist/_dts/sdk/src/cli/merge-remote/sharedMergeReport.d.ts +0 -63
  157. package/dist/_dts/sdk/src/cli/migrations/entries.d.ts +0 -28
  158. package/dist/_dts/sdk/src/cli/migrations/events.d.ts +0 -73
  159. package/dist/_dts/sdk/src/cli/navigationIdentity.d.ts +0 -11
  160. package/dist/_dts/sdk/src/cli/output.d.ts +0 -133
  161. package/dist/_dts/sdk/src/cli/program.d.ts +0 -29
  162. package/dist/_dts/sdk/src/cli/push-config.d.ts +0 -49
  163. package/dist/_dts/sdk/src/cli/setup/setupPlan.d.ts +0 -51
  164. package/dist/_dts/sdk/src/cli/site-commands/commandKeys.d.ts +0 -13
  165. package/dist/_dts/sdk/src/cli/site-commands/commandRuntime.d.ts +0 -170
  166. package/dist/_dts/sdk/src/cli/site-commands/commandRuntimeCompat.d.ts +0 -21
  167. package/dist/_dts/sdk/src/cli/site-commands/commandSurfaceDispatch.d.ts +0 -32
  168. package/dist/_dts/sdk/src/cli/site-commands/datedOfferingCommands.d.ts +0 -53
  169. package/dist/_dts/sdk/src/cli/site-commands/entryCommands.d.ts +0 -65
  170. package/dist/_dts/sdk/src/cli/site-commands/eventScheduleCompiler.d.ts +0 -24
  171. package/dist/_dts/sdk/src/cli/site-commands/footerCommands.d.ts +0 -68
  172. package/dist/_dts/sdk/src/cli/site-commands/formCommands.d.ts +0 -53
  173. package/dist/_dts/sdk/src/cli/site-commands/index.d.ts +0 -8
  174. package/dist/_dts/sdk/src/cli/site-commands/localBlockManifestResolver.d.ts +0 -31
  175. package/dist/_dts/sdk/src/cli/site-commands/navigationCommands.d.ts +0 -57
  176. package/dist/_dts/sdk/src/cli/site-commands/oneOffCommands.d.ts +0 -82
  177. package/dist/_dts/sdk/src/cli/site-commands/pageCommands.d.ts +0 -84
  178. package/dist/_dts/sdk/src/cli/site-commands/pushExecution.d.ts +0 -39
  179. package/dist/_dts/sdk/src/cli/site-commands/pushExecutionPlan.d.ts +0 -8
  180. package/dist/_dts/sdk/src/cli/site-commands/pushExecutionTypes.d.ts +0 -97
  181. package/dist/_dts/sdk/src/cli/site-commands/residualSettingsTrimming.d.ts +0 -15
  182. package/dist/_dts/sdk/src/cli/sync/diff.d.ts +0 -222
  183. package/dist/_dts/sdk/src/cli/sync/executor.d.ts +0 -84
  184. package/dist/_dts/sdk/src/cli/sync/field-diff.d.ts +0 -39
  185. package/dist/_dts/sdk/src/cli/sync/index.d.ts +0 -10
  186. package/dist/_dts/sdk/src/cli/sync/mapper.d.ts +0 -41
  187. package/dist/_dts/sdk/src/cli/sync/media-sync.d.ts +0 -15
  188. package/dist/_dts/sdk/src/cli/sync/media.d.ts +0 -158
  189. package/dist/_dts/sdk/src/cli/sync/syncResultAggregation.d.ts +0 -4
  190. package/dist/_dts/sdk/src/cli/sync/validation.d.ts +0 -68
  191. package/dist/_dts/sdk/src/cli/utils/checksum.d.ts +0 -1
  192. package/dist/_dts/sdk/src/client/management/blocks.d.ts +0 -19
  193. package/dist/_dts/sdk/src/client/management/catalog.d.ts +0 -10
  194. package/dist/_dts/sdk/src/client/management/entries.d.ts +0 -6
  195. package/dist/_dts/sdk/src/client/management/eventCategories.d.ts +0 -6
  196. package/dist/_dts/sdk/src/client/management/events.d.ts +0 -7
  197. package/dist/_dts/sdk/src/client/management/footer.d.ts +0 -9
  198. package/dist/_dts/sdk/src/client/management/forms.d.ts +0 -6
  199. package/dist/_dts/sdk/src/client/management/http.d.ts +0 -79
  200. package/dist/_dts/sdk/src/client/management/identifiers.d.ts +0 -11
  201. package/dist/_dts/sdk/src/client/management/index.d.ts +0 -41
  202. package/dist/_dts/sdk/src/client/management/media.d.ts +0 -72
  203. package/dist/_dts/sdk/src/client/management/navigation.d.ts +0 -6
  204. package/dist/_dts/sdk/src/client/management/pages.d.ts +0 -6
  205. package/dist/_dts/sdk/src/client/management/pull.d.ts +0 -6
  206. package/dist/_dts/sdk/src/client/management/settings-branding.d.ts +0 -32
  207. package/dist/_dts/sdk/src/client/management/settings.d.ts +0 -6
  208. package/dist/_dts/sdk/src/client/management/theme.d.ts +0 -8
  209. package/dist/_dts/sdk/src/client/management/types.d.ts +0 -1069
  210. package/dist/_dts/sdk/src/client/management/venues.d.ts +0 -6
  211. package/dist/_dts/sdk/src/client/management/webhooks.d.ts +0 -3
  212. package/dist/_dts/sdk/src/test/env.d.ts +0 -4
  213. package/dist/_dts/site-commands/src/adapter.d.ts +0 -23
  214. package/dist/_dts/site-commands/src/appointmentCommandSchemas.d.ts +0 -100
  215. package/dist/_dts/site-commands/src/capabilityGaps.d.ts +0 -8
  216. package/dist/_dts/site-commands/src/commandContract.d.ts +0 -1277
  217. package/dist/_dts/site-commands/src/commandDomain.d.ts +0 -20
  218. package/dist/_dts/site-commands/src/commandIdentifiers.d.ts +0 -7
  219. package/dist/_dts/site-commands/src/commandValidation.d.ts +0 -10
  220. package/dist/_dts/site-commands/src/commands.d.ts +0 -1983
  221. package/dist/_dts/site-commands/src/domain.d.ts +0 -104
  222. package/dist/_dts/site-commands/src/eventCommandContent.d.ts +0 -11
  223. package/dist/_dts/site-commands/src/exposure.d.ts +0 -41
  224. package/dist/_dts/site-commands/src/guards.d.ts +0 -1
  225. package/dist/_dts/site-commands/src/index.d.ts +0 -18
  226. package/dist/_dts/site-commands/src/metadata.d.ts +0 -555
  227. package/dist/_dts/site-commands/src/pagePaths.d.ts +0 -6
  228. package/dist/_dts/site-commands/src/planner.d.ts +0 -58
  229. package/dist/_dts/site-commands/src/refContributions.d.ts +0 -11
  230. package/dist/_dts/site-commands/src/refs.d.ts +0 -90
  231. package/dist/_dts/site-commands/src/siteStyleCommandSchema.d.ts +0 -405
  232. package/dist/_dts/site-commands/src/siteStyleSelectionSchemaBuilder.d.ts +0 -46
  233. package/dist/_dts/site-commands/src/stableJson.d.ts +0 -5
  234. package/dist/_dts/site-commands/src/staticExecutionGaps.d.ts +0 -10
  235. package/dist/_dts/site-commands/src/venueCommandMapping.d.ts +0 -21
  236. package/dist/_dts/theme-core/src/data.d.ts +0 -12
  237. package/dist/_dts/theme-core/src/site-styles/headerStyleParts.d.ts +0 -4
  238. package/dist/cli/index.mjs +0 -162988
  239. package/dist/cli/init-docs/content/agents-section.md +0 -67
  240. package/dist/cli/init-docs/content/cli-reference.md +0 -1238
  241. package/dist/cli/init-docs/content/content-management.md +0 -792
  242. package/dist/cli/init-docs/content/context-brand.md +0 -125
  243. package/dist/cli/init-docs/content/context-brief.md +0 -77
  244. package/dist/cli/init-docs/content/context-knowledge.md +0 -111
  245. package/dist/cli/init-docs/content/getting-started.md +0 -171
  246. package/dist/cli/init-docs/content/site-workflows-readme.md +0 -96
  247. package/dist/cli/init-docs/content/workflow-add-block.md +0 -299
  248. package/dist/cli/init-docs/content/workflow-agent-safe-sync.md +0 -83
  249. package/dist/cli/init-docs/content/workflow-block-extensions.md +0 -370
  250. package/dist/cli/init-docs/content/workflow-cmsify-page.md +0 -357
  251. package/dist/cli/init-docs/content/workflow-content-types.md +0 -330
  252. package/dist/cli/init-docs/content/workflow-create-page.md +0 -212
  253. package/dist/cli/init-docs/content/workflow-custom-block.md +0 -470
  254. package/dist/cli/init-docs/content/workflow-editor-workflows.md +0 -130
  255. package/dist/cli/init-docs/content/workflow-isr-revalidation.md +0 -158
  256. package/dist/cli/init-docs/content/workflow-preview-mode.md +0 -252
  257. package/dist/cli/init-docs/content/workflow-publish.md +0 -285
  258. package/dist/cli/init-docs/content/workflow-remote-setup.md +0 -51
  259. package/dist/cli/init-docs/content/workflow-templates.md +0 -381
  260. /package/dist/_dts/{sdk/src/cli/utils/mime.d.ts → media-core/src/mimeType.d.ts} +0 -0
@@ -1,125 +0,0 @@
1
- # Brand Assets
2
-
3
- This document helps AI agents understand the visual brand identity for consistent content creation.
4
-
5
- ## Purpose
6
-
7
- Document brand assets and guidelines including:
8
-
9
- - Logo usage and variations
10
- - Color palette
11
- - Typography
12
- - Image and illustration style
13
- - Design patterns
14
-
15
- ## Color Palette
16
-
17
- Define the brand colors:
18
-
19
- ```
20
- Primary: #______ (e.g., #0066CC - main brand color)
21
- Secondary: #______ (e.g., #00CC66 - accent color)
22
- Accent: #______ (e.g., #CC6600 - highlight color)
23
-
24
- Neutrals:
25
- - Dark: #______ (e.g., #1A1A1A - headings, body text)
26
- - Medium: #______ (e.g., #666666 - secondary text)
27
- - Light: #______ (e.g., #F5F5F5 - backgrounds)
28
- - White: #FFFFFF
29
-
30
- Status:
31
- - Success: #______ (e.g., #22C55E)
32
- - Warning: #______ (e.g., #F59E0B)
33
- - Error: #______ (e.g., #EF4444)
34
- - Info: #______ (e.g., #3B82F6)
35
- ```
36
-
37
- ## Typography
38
-
39
- Define the font families:
40
-
41
- ```
42
- Headings: [Font Name], [weight] (e.g., Inter, bold)
43
- Body: [Font Name], [weight] (e.g., Inter, regular)
44
- Code: [Font Name] (e.g., JetBrains Mono)
45
- ```
46
-
47
- **Heading sizes:**
48
- - H1: (e.g., 48px / 3rem)
49
- - H2: (e.g., 36px / 2.25rem)
50
- - H3: (e.g., 24px / 1.5rem)
51
- - H4: (e.g., 20px / 1.25rem)
52
-
53
- **Body text:** (e.g., 16px / 1rem, line-height 1.6)
54
-
55
- ## Logo Files
56
-
57
- Reference paths to logo files:
58
-
59
- | Variant | Path | Usage |
60
- |---------|------|-------|
61
- | Primary | `/public/logo.svg` | Main logo for light backgrounds |
62
- | Dark mode | `/public/logo-dark.svg` | For dark backgrounds |
63
- | Icon only | `/public/logo-icon.svg` | Favicon, small spaces |
64
- | Full width | `/public/logo-full.svg` | Header, large displays |
65
-
66
- **Logo usage guidelines:**
67
- - Minimum clear space: (e.g., equal to the height of the logomark)
68
- - Minimum size: (e.g., 100px width for full logo, 24px for icon)
69
- - Don't stretch, rotate, or alter colors
70
-
71
- ## Image Style
72
-
73
- Guidelines for imagery:
74
-
75
- **Photography:**
76
- - Style: (e.g., bright and modern, lifestyle-focused, professional)
77
- - Subjects: (e.g., people using products, workspace shots, abstract)
78
- - Avoid: (e.g., stock photo cliches, outdated imagery)
79
-
80
- **Illustrations:**
81
- - Style: (e.g., flat design, 3D, hand-drawn, geometric)
82
- - Color usage: (e.g., use brand colors only, limited palette)
83
-
84
- **Aspect ratios:**
85
- - Hero images: (e.g., 16:9, 1920x1080 minimum)
86
- - Blog thumbnails: (e.g., 3:2, 1200x800)
87
- - Social sharing: (e.g., 1.91:1 for Open Graph)
88
-
89
- ## Icons
90
-
91
- Icon style and sources:
92
-
93
- - **Icon set**: (e.g., Lucide, Heroicons, custom)
94
- - **Style**: (e.g., outline, solid, duotone)
95
- - **Size**: (e.g., 24px default, 16px small, 32px large)
96
- - **Color**: (e.g., inherit from text, or specific brand color)
97
-
98
- ## Example Completed Section
99
-
100
- ```markdown
101
- ## Color Palette
102
-
103
- Primary: #2563EB (Blue - main brand color)
104
- Secondary: #10B981 (Green - success states, CTAs)
105
- Accent: #8B5CF6 (Purple - highlights)
106
-
107
- Neutrals:
108
- - Dark: #111827 (Gray 900 - headings)
109
- - Medium: #6B7280 (Gray 500 - body text)
110
- - Light: #F9FAFB (Gray 50 - backgrounds)
111
- - White: #FFFFFF
112
-
113
- ## Typography
114
-
115
- Headings: Inter, semibold (600)
116
- Body: Inter, regular (400)
117
- Code: Fira Code, regular
118
-
119
- ## Image Style
120
-
121
- Photography: Clean, bright, professional. Real people in real workspaces.
122
- Illustrations: Flat design with brand colors. Simple, modern, friendly.
123
-
124
- Avoid: Dark/moody imagery, overly complex graphics, generic stock photos.
125
- ```
@@ -1,77 +0,0 @@
1
- # Site Brief
2
-
3
- This document helps AI agents understand the brand, tone, and goals for this site. Fill in the sections below to provide context for content creation.
4
-
5
- ## Brand Voice
6
-
7
- Describe how the brand communicates:
8
-
9
- - **Tone**: (e.g., professional, friendly, technical, casual, authoritative)
10
- - **Personality**: (e.g., helpful, innovative, trustworthy, playful)
11
- - **Language style**: (e.g., simple and direct, detailed and thorough, conversational)
12
-
13
- **Words/phrases to use:**
14
- - (Add brand-appropriate terminology)
15
-
16
- **Words/phrases to avoid:**
17
- - (Add terms that don't fit the brand)
18
-
19
- ## Target Audience
20
-
21
- Who is this site for?
22
-
23
- - **Primary audience**: (e.g., small business owners, developers, enterprise teams)
24
- - **Secondary audience**: (if applicable)
25
- - **Technical level**: (e.g., beginner, intermediate, expert)
26
- - **Key pain points**: (what problems are they trying to solve?)
27
-
28
- ## Site Purpose
29
-
30
- What is this site meant to achieve?
31
-
32
- - **Primary goal**: (e.g., generate leads, sell products, provide information)
33
- - **Secondary goals**: (e.g., build brand awareness, support customers)
34
- - **Key user journeys**: (what should visitors do on the site?)
35
-
36
- ## Content Guidelines
37
-
38
- Standards for content creation:
39
-
40
- - **Preferred content length**: (e.g., blog posts 800-1200 words)
41
- - **Heading style**: (e.g., sentence case, title case)
42
- - **Image requirements**: (e.g., minimum resolution, preferred aspect ratios)
43
- - **SEO focus areas**: (key topics or keywords)
44
-
45
- ## Example
46
-
47
- ```markdown
48
- ## Brand Voice
49
-
50
- - **Tone**: Professional but approachable
51
- - **Personality**: Helpful, knowledgeable, straightforward
52
- - **Language style**: Clear and concise, avoid jargon unless necessary
53
-
54
- **Words to use:** streamline, efficient, simple, powerful, reliable
55
- **Words to avoid:** synergy, leverage, disrupt, revolutionary
56
-
57
- ## Target Audience
58
-
59
- - **Primary**: Small to medium business owners looking for a CMS
60
- - **Technical level**: Intermediate - comfortable with technology but not developers
61
- - **Pain points**: Current CMS is too complex, need better content management
62
-
63
- ## Site Purpose
64
-
65
- - **Primary goal**: Convert visitors to trial signups
66
- - **Key journeys**:
67
- 1. Learn about features → Start free trial
68
- 2. Read case studies → Request demo
69
- 3. Check pricing → Choose plan
70
-
71
- ## Content Guidelines
72
-
73
- - Blog posts: 1000-1500 words
74
- - All headings in sentence case
75
- - Include at least one image per blog post
76
- - Focus on "headless CMS" and "content management" keywords
77
- ```
@@ -1,111 +0,0 @@
1
- # Knowledge Base
2
-
3
- This directory stores domain knowledge, reference information, and facts that AI agents need when working with this site's content.
4
-
5
- ## Purpose
6
-
7
- Help agents understand:
8
-
9
- - Industry terminology and definitions
10
- - Product or service details
11
- - Technical specifications
12
- - Frequently asked questions
13
- - Reference data and statistics
14
-
15
- ## Suggested Organization
16
-
17
- Create files for different knowledge areas:
18
-
19
- | File | Purpose |
20
- |------|---------|
21
- | `products.md` | Product catalog, features, specifications |
22
- | `services.md` | Service offerings and descriptions |
23
- | `faq.md` | Common questions and answers |
24
- | `glossary.md` | Industry terms and definitions |
25
- | `competitors.md` | Competitive landscape and differentiation |
26
- | `stats.md` | Key statistics and data points |
27
-
28
- ## Example File Format
29
-
30
- ### products.md
31
-
32
- ```markdown
33
- # Products
34
-
35
- ## Product: Widget Pro
36
-
37
- - **SKU**: WP-001
38
- - **Category**: Automation Tools
39
- - **Price**: $99/month
40
- - **Target customer**: Small business teams
41
-
42
- ### Key Features
43
- - Feature A: Description of what it does
44
- - Feature B: Description of what it does
45
- - Feature C: Description of what it does
46
-
47
- ### Use Cases
48
- - Scenario 1: How customers use this
49
- - Scenario 2: Another common use case
50
-
51
- ### Comparison to Widget Basic
52
- - Pro has X, Basic doesn't
53
- - Pro supports Y users, Basic supports Z
54
- ```
55
-
56
- ### glossary.md
57
-
58
- ```markdown
59
- # Glossary
60
-
61
- ## A
62
-
63
- **API (Application Programming Interface)**
64
- A set of protocols that allows different software applications to communicate.
65
-
66
- **Authentication**
67
- The process of verifying user identity before granting access.
68
-
69
- ## B
70
-
71
- **Block**
72
- A modular content component in RiverbankCMS (e.g., hero, text, image).
73
-
74
- ## C
75
-
76
- **CMS (Content Management System)**
77
- Software for creating, managing, and publishing digital content.
78
-
79
- **Content Type**
80
- A defined structure for a category of content (e.g., blog posts, products).
81
- ```
82
-
83
- ### faq.md
84
-
85
- ```markdown
86
- # Frequently Asked Questions
87
-
88
- ## General
89
-
90
- **Q: What is [Product Name]?**
91
- A: [Product Name] is a [brief description]. It helps [target audience] to [main benefit].
92
-
93
- **Q: How much does it cost?**
94
- A: Pricing starts at $X/month. See our pricing page for full details.
95
-
96
- ## Technical
97
-
98
- **Q: What integrations are available?**
99
- A: We integrate with [List of integrations]. Custom integrations are available via our API.
100
-
101
- **Q: Is there a free trial?**
102
- A: Yes, we offer a 14-day free trial with full access to all features.
103
- ```
104
-
105
- ## Best Practices
106
-
107
- - Keep information factual and up-to-date
108
- - Use consistent formatting across files
109
- - Include dates when information might become outdated
110
- - Cross-reference related topics
111
- - Update when products, services, or facts change
@@ -1,171 +0,0 @@
1
- # Getting Started with RiverbankCMS SDK
2
-
3
- This site uses RiverbankCMS as a headless CMS. Content is managed through the SDK CLI.
4
-
5
- ## Quick Setup
6
-
7
- ### 1. Verify Environment Configuration
8
-
9
- Check `.env.local` has these variables:
10
-
11
- ```bash
12
- # Local development
13
- RIVERBANK_LOCAL_SITE_ID=your-site-id
14
- RIVERBANK_LOCAL_DASHBOARD_URL=http://localhost:4000
15
- RIVERBANK_LOCAL_MGMT_API_KEY=bld_mgmt_sk_...
16
-
17
- # Production (optional)
18
- RIVERBANK_REMOTE_SITE_ID=your-site-id
19
- RIVERBANK_REMOTE_DASHBOARD_URL=https://your-dashboard.riverbankcms.com
20
- RIVERBANK_REMOTE_MGMT_API_KEY=bld_mgmt_sk_...
21
- ```
22
-
23
- ### 2. Pull Content
24
-
25
- Download current content from the CMS:
26
-
27
- ```bash
28
- riverbankcms pull
29
- ```
30
-
31
- This creates a `content/` directory with JSON files:
32
-
33
- ```
34
- content/
35
- ├── entries/
36
- │ └── [content-type].json
37
- ├── pages/
38
- │ └── [page-identifier].json
39
- ├── themes/
40
- │ └── current.json
41
- └── navigation.json
42
- ```
43
-
44
- You can also pull just the theme:
45
-
46
- ```bash
47
- riverbankcms pull theme
48
- ```
49
-
50
- ### 3. Make Changes
51
-
52
- Edit the JSON files directly, or use CLI commands:
53
-
54
- ```bash
55
- # Create or update an entry
56
- riverbankcms entry upsert blog-post my-new-post --data '{"title": "New Post"}'
57
-
58
- # Create a page
59
- riverbankcms page upsert about --title "About Us" --path /about
60
-
61
- # Add a block to a page
62
- riverbankcms block upsert about hero-section --kind block.hero --data '{"heading": "About Us"}'
63
- ```
64
-
65
- ### 4. Push Changes
66
-
67
- Preview what would change:
68
-
69
- ```bash
70
- riverbankcms push --dry-run
71
- ```
72
-
73
- Apply changes to the CMS:
74
-
75
- ```bash
76
- riverbankcms push
77
- ```
78
-
79
- ## Local Theme Iteration (Edge-safe)
80
-
81
- If your SDK site uses `createCatchAllPage()`, you can render with local theme objects (and switch themes at runtime) without pushing theme changes to the CMS. See `cli-reference.md` for theme pull/push commands and the SDK README for the `createCatchAllPage({ themes, themeSwitch })` API.
82
-
83
- Event registration blocks need both the SDK base stylesheet and a runtime theme scope. Generated SDK pages that render inside `Layout` get `ThemeScope` by default. Standalone `Page` or `Block` usage should wrap registration content in `ThemeBridgeProvider` or manual `generateThemeBridgeCss` with a `data-theme-scope="sdk"` wrapper; keep visual changes in scoped CSS variables instead of forking booking logic.
84
-
85
- ## Key Documentation
86
-
87
- | Document | Purpose |
88
- | ----------------------- | ---------------------------------------------------------------- |
89
- | `cli-reference.md` | All CLI commands and options |
90
- | `content-management.md` | How content is structured |
91
- | `schema.md` | This site's content types and blocks (auto-generated) |
92
- | `block-types.md` | Available block types (auto-generated) |
93
- | `theme-schema.md` | Theme schema reference (auto-generated from Zod) |
94
- | `workflows/` | Step-by-step guides for common tasks, including editor workflows |
95
- | `workflows/agent-safe-sync.md` | Agent-safe dry-run, scoped push, and stale-content handling |
96
-
97
- ## Common Tasks
98
-
99
- | Task | Command |
100
- | ---------------- | --------------------------------------------------------------------- |
101
- | Pull all content | `riverbankcms pull` |
102
- | Push changes | `riverbankcms push` |
103
- | Preview changes | `riverbankcms push --dry-run` |
104
- | Create a page | `riverbankcms page upsert <id> --title "..." --path /...` |
105
- | Add a block | `riverbankcms block upsert <page> <block-id> --kind ... --data '...'` |
106
- | Publish an entry | `riverbankcms entry publish <type> <id>` |
107
- | Publish a page | `riverbankcms page publish <id>` |
108
- | List entries | `riverbankcms entry list <type>` |
109
- | Get JSON output | Add `--json` to any command |
110
-
111
- ## Configuration Files
112
-
113
- ### riverbank.config.ts
114
-
115
- Main SDK configuration defining:
116
-
117
- - Site ID
118
- - Custom blocks
119
- - Block field extensions
120
- - Block field options
121
- - Content type definitions
122
- - Sync settings
123
-
124
- ### content.config.ts (if present)
125
-
126
- Additional content configuration for scaffolding.
127
-
128
- ## Working with Remote/Production
129
-
130
- If the remote site, management key, or dashboard user access is not set up yet, start with the safe setup planner:
131
-
132
- ```bash
133
- riverbankcms setup plan --env=remote
134
- ```
135
-
136
- See `workflows/remote-setup.md` for the full site/key/user lifecycle. The SDK CLI uses site-scoped management keys for sync; remote site creation, key issuance, and user access changes stay in the dashboard/admin surface.
137
-
138
- Use `--env=remote` to target production instead of local:
139
-
140
- ```bash
141
- # Pull from production
142
- riverbankcms pull --env=remote
143
-
144
- # Push to production (requires --yes for safety)
145
- riverbankcms push --env=remote --yes
146
- ```
147
-
148
- **Safety note:** Remote push requires `--yes` flag to prevent accidental production changes.
149
-
150
- Prefer the CLI `--env` flag over shell prefixes such as `RIVERBANK_ENV=remote riverbankcms ...`. Site `.env.local` files often contain their own `RIVERBANK_ENV` value, while `--env=remote` is explicit and reliable for CLI sync commands.
151
-
152
- For narrow production edits, dry-run and apply the smallest scope:
153
-
154
- ```bash
155
- riverbankcms push pages privacy-policy --env=remote --dry-run
156
- riverbankcms push pages privacy-policy --env=remote --yes
157
- ```
158
-
159
- If local content includes unrelated differences, see `workflows/agent-safe-sync.md` for the temporary `--content-dir` pattern.
160
-
161
- ## Media Safety (Avoid Broken Images)
162
-
163
- - Portable content JSON should store media as **identifier-only** (no `assetId` / storage paths / `src`).
164
- - Download media bytes to disk: `riverbankcms pull --local-media`
165
- - Optional (CMS → CMS): sync media bytes by identifier + checksum: `riverbankcms pull --env=remote --sync-media --yes`
166
-
167
- ## Next Steps
168
-
169
- 1. Read `cli-reference.md` for detailed command documentation
170
- 2. Review `schema.md` to understand this site's content model
171
- 3. Check `workflows/` for step-by-step guides
@@ -1,96 +0,0 @@
1
- # Site-Specific Workflows
2
-
3
- This directory is for workflows specific to this site. The core workflows in `../workflows/` cover generic SDK operations, while this folder is for site-specific procedures.
4
-
5
- ## When to Add Site Workflows
6
-
7
- Add workflows here when you have:
8
-
9
- - **Site-specific content patterns** - e.g., "How to add a new product to the catalog"
10
- - **Custom block configurations** - e.g., "Setting up the featured posts carousel"
11
- - **Multi-step business processes** - e.g., "Publishing a campaign landing page"
12
- - **Integration procedures** - e.g., "Syncing content with the marketing site"
13
-
14
- ## Creating a Workflow
15
-
16
- Create a markdown file following this structure:
17
-
18
- ```markdown
19
- # Workflow: [Name]
20
-
21
- ## Purpose
22
-
23
- What this workflow accomplishes and when to use it.
24
-
25
- ## Prerequisites
26
-
27
- - Required access, tools, or setup
28
- - Any content that must exist first
29
-
30
- ## Steps
31
-
32
- 1. First step with command
33
- ```bash
34
- riverbankcms ...
35
- ```
36
-
37
- 2. Second step
38
- ```bash
39
- riverbankcms ...
40
- ```
41
-
42
- ## Verification
43
-
44
- How to confirm the workflow completed successfully.
45
-
46
- ## Rollback (if applicable)
47
-
48
- How to undo the changes if needed.
49
-
50
- ## Notes
51
-
52
- Any additional context or edge cases.
53
- ```
54
-
55
- ## Example Workflows
56
-
57
- ### Site-specific content creation
58
-
59
- `create-product.md`:
60
- ```markdown
61
- # Workflow: Create a Product
62
-
63
- ## Purpose
64
- Add a new product to the catalog with all required fields.
65
-
66
- ## Steps
67
- 1. Create the product entry
68
- 2. Add product images
69
- 3. Link to category
70
- 4. Publish
71
- ```
72
-
73
- ### Campaign or seasonal content
74
-
75
- `launch-campaign.md`:
76
- ```markdown
77
- # Workflow: Launch Marketing Campaign
78
-
79
- ## Purpose
80
- Create and publish a campaign landing page with all blocks.
81
-
82
- ## Steps
83
- 1. Create campaign page
84
- 2. Add hero with campaign messaging
85
- 3. Add product grid
86
- 4. Add CTA section
87
- 5. Preview and publish
88
- ```
89
-
90
- ## Best Practices
91
-
92
- - Keep workflows focused on one task
93
- - Include all commands needed (copy-pasteable)
94
- - Document site-specific field requirements
95
- - Reference the CLI reference for command details
96
- - Update workflows when the site schema changes