@astryxdesign/cli 0.6.4 → 0.6.5-canary.01972bc
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/CHANGELOG.md +56 -0
- package/README.md +103 -95
- package/api/build/_adapter.d.mts +36 -2
- package/api/build/_adapter.mjs +41 -10
- package/api/build/build.doc.mjs +8 -3
- package/api/build/build.test.mjs +60 -2
- package/api/build/kit/kit.mjs +109 -26
- package/api/build/kit/rank.d.mts +24 -8
- package/api/build/kit/rank.mjs +277 -97
- package/api/build/kit/rank.test.mjs +231 -48
- package/api/component/_adapter.d.mts +25 -0
- package/api/component/_adapter.mjs +59 -5
- package/api/component/component.d.mts +6 -3
- package/api/component/component.doc.mjs +37 -17
- package/api/component/component.mjs +249 -9
- package/api/component/component.type.d.mts +25 -0
- package/api/component/component.type.mjs +44 -0
- package/api/discover/_adapter.d.mts +114 -6
- package/api/discover/_adapter.mjs +372 -17
- package/api/discover/_adapter.test.mjs +215 -0
- package/api/discover/_catalog-view.d.mts +115 -0
- package/api/discover/_catalog-view.mjs +203 -0
- package/api/discover/_catalog-view.test.mjs +128 -0
- package/api/discover/detail/detail.d.mts +18 -6
- package/api/discover/detail/detail.mjs +67 -13
- package/api/discover/detail/detail.test.mjs +85 -0
- package/api/discover/detail/item/item.d.mts +26 -0
- package/api/discover/detail/item/item.mjs +78 -0
- package/api/discover/detail/item/item.test.mjs +73 -0
- package/api/discover/discover.d.mts +3 -9
- package/api/discover/discover.doc.mjs +61 -18
- package/api/discover/discover.mjs +220 -36
- package/api/discover/discover.test.mjs +11 -2
- package/api/discover/discover.type.d.mts +147 -8
- package/api/discover/discover.type.mjs +102 -12
- package/api/discover/list/list.d.mts +20 -6
- package/api/discover/list/list.mjs +45 -12
- package/api/discover/list/list.test.mjs +46 -0
- package/api/discover/search/search.d.mts +18 -16
- package/api/discover/search/search.mjs +102 -56
- package/api/discover/search/search.test.mjs +144 -10
- package/api/docs/_adapter.d.mts +8 -3
- package/api/docs/_adapter.mjs +14 -6
- package/api/docs/docOverlays.test.mjs +27 -1
- package/api/docs/docs.doc.mjs +2 -2
- package/api/docs/docs.test.mjs +54 -18
- package/api/docs/integration-tree.test.mjs +17 -0
- package/api/docs/integrationDocs.test.mjs +27 -5
- package/api/doctor/doctor.d.mts +8 -3
- package/api/doctor/doctor.doc.mjs +17 -8
- package/api/doctor/doctor.mjs +90 -9
- package/api/doctor/doctor.test.mjs +122 -10
- package/api/doctor/doctor.type.d.mts +1 -1
- package/api/doctor/doctor.type.mjs +1 -1
- package/api/error.d.mts +22 -0
- package/api/error.mjs +42 -0
- package/api/gap-report/gap-report.doc.mjs +19 -10
- package/api/hook/hook.doc.mjs +6 -3
- package/api/index.d.mts +1 -0
- package/api/index.mjs +5 -3
- package/api/init/init.doc.mjs +17 -12
- package/api/integration/add-contribution.d.mts +2 -1
- package/api/integration/add-contribution.mjs +7 -3
- package/api/integration/add-contribution.test.mjs +3 -3
- package/api/integration/add-helpers.d.mts +5 -2
- package/api/integration/add-helpers.mjs +36 -9
- package/api/integration/add-theme.mjs +266 -23
- package/api/integration/add-theme.test.mjs +247 -0
- package/api/integration/authoring-checks.mjs +12 -9
- package/api/integration/authoring-checks.type.d.mts +8 -0
- package/api/integration/authoring-checks.type.mjs +7 -3
- package/api/integration/integration-authoring.type.d.mts +4 -1
- package/api/integration/integration-authoring.type.mjs +6 -1
- package/api/integration/integrationAdd.doc.mjs +6 -0
- package/api/integration/integrationAddTheme.doc.mjs +10 -0
- package/api/integration/integrationComponentConflicts.doc.mjs +1 -1
- package/api/integration/integrationDocConflicts.doc.mjs +1 -1
- package/api/integration/integrationPackCheck.doc.mjs +3 -3
- package/api/integration/integrationTemplateConflicts.doc.mjs +1 -1
- package/api/integration/pack-check.lifecycle-output.test.mjs +107 -0
- package/api/integration/pack-check.mjs +92 -10
- package/api/integration/pack-check.test.mjs +140 -1
- package/api/integration/pack-check.type.mjs +1 -1
- package/api/integration/validate-integration.d.mts +4 -2
- package/api/integration/validate-integration.mjs +7 -2
- package/api/integration/validate-integration.test.mjs +55 -0
- package/api/integration/validate-integration.type.d.mts +5 -0
- package/api/integration/validate-integration.type.mjs +5 -1
- package/api/integration/validateIntegration.doc.mjs +1 -1
- package/api/json/assertResponse.doc.mjs +1 -1
- package/api/json/isError.doc.mjs +1 -1
- package/api/layout/expand/expand.mjs +12 -7
- package/api/layout/expand/expand.receipt.test.mjs +74 -0
- package/api/layout/layout.type.d.mts +1 -0
- package/api/layout/layout.type.mjs +1 -0
- package/api/layout/layoutExpand.doc.mjs +1 -1
- package/api/search/search.d.mts +51 -1
- package/api/search/search.doc.mjs +2 -2
- package/api/search/search.mjs +299 -17
- package/api/search/search.test.mjs +216 -18
- package/api/swizzle/copy/copy.mjs +66 -3
- package/api/swizzle/swizzle.doc.mjs +11 -5
- package/api/template/copy/copy.mjs +15 -9
- package/api/template/copy/copy.receipt.test.mjs +77 -0
- package/api/template/copy/copy.test.mjs +9 -0
- package/api/template/show/show.mjs +15 -4
- package/api/template/show/show.test.mjs +76 -0
- package/api/template/template-integration.test.mjs +14 -0
- package/api/template/template.d.mts +1 -1
- package/api/template/template.doc.mjs +8 -3
- package/api/template/template.mjs +1 -0
- package/api/template/template.type.d.mts +2 -0
- package/api/template/template.type.mjs +2 -0
- package/api/theme/add/add.mjs +17 -25
- package/api/theme/add/add.rollback.test.mjs +158 -0
- package/api/theme/add/add.staging.test.mjs +40 -23
- package/api/theme/build/build.d.mts +24 -0
- package/api/theme/build/build.family.test.mjs +7 -12
- package/api/theme/build/build.mjs +243 -26
- package/api/theme/build/build.project-core.test.mjs +165 -0
- package/api/theme/build/build.rollback.test.mjs +148 -0
- package/api/theme/generateTonalPalette.doc.mjs +1 -2
- package/api/theme/listThemes.doc.mjs +1 -1
- package/api/theme/themeAdd.doc.mjs +9 -10
- package/api/theme/themeBuild.doc.mjs +13 -13
- package/api/theme/themeList.doc.mjs +1 -1
- package/api/theme/themeListAvailable.doc.mjs +2 -1
- package/api/theme/themePaletteGenerate.doc.mjs +15 -8
- package/api/theme/themeTargets.doc.mjs +3 -2
- package/api/theme/themeTemplate.doc.mjs +2 -1
- package/api/upgrade/run/files-changed.test.mjs +111 -0
- package/api/upgrade/run/run.mjs +25 -6
- package/api/upgrade/run/run.test.mjs +45 -1
- package/api/upgrade/upgrade.doc.mjs +24 -22
- package/api/upgrade/upgrade.type.d.mts +1 -0
- package/api/upgrade/upgrade.type.mjs +3 -2
- package/assets/codemods/__tests__/runner.test.mjs +3 -1
- package/assets/codemods/file-count.test.mjs +163 -0
- package/assets/codemods/integration-runner.mjs +3 -3
- package/assets/codemods/runner.mjs +5 -4
- package/assets/docs/README.md +4 -2
- package/assets/docs/browser-support.doc.mjs +11 -11
- package/assets/docs/color.doc.mjs +8 -2
- package/assets/docs/elevation.doc.mjs +6 -4
- package/assets/docs/getting-started.doc.mjs +5 -16
- package/assets/docs/icons.doc.mjs +3 -21
- package/assets/docs/illustrations.doc.mjs +7 -15
- package/assets/docs/internationalization.doc.mjs +7 -5
- package/assets/docs/layout.doc.dense.mjs +130 -82
- package/assets/docs/layout.doc.mjs +133 -77
- package/assets/docs/migration.doc.mjs +19 -21
- package/assets/docs/motion.doc.mjs +16 -3
- package/assets/docs/principles.doc.dense.mjs +5 -5
- package/assets/docs/principles.doc.mjs +8 -0
- package/assets/docs/principles.doc.zh.mjs +6 -6
- package/assets/docs/shape.doc.mjs +8 -3
- package/assets/docs/spacing.doc.mjs +7 -2
- package/assets/docs/styling-libraries.doc.mjs +6 -2
- package/assets/docs/styling.doc.mjs +19 -23
- package/assets/docs/theme.doc.dense.mjs +58 -18
- package/assets/docs/theme.doc.mjs +57 -47
- package/assets/docs/theme.doc.zh.mjs +9 -8
- package/assets/docs/tokens.doc.dense.mjs +2 -2
- package/assets/docs/tokens.doc.mjs +389 -8
- package/assets/docs/tokens.doc.zh.mjs +2 -2
- package/assets/docs/tree/add-a-component.doc.mjs +75 -0
- package/assets/docs/tree/add-a-theme.doc.mjs +85 -0
- package/assets/docs/tree/add-a-topic.doc.mjs +144 -0
- package/assets/docs/tree/agent-guidance.doc.mjs +138 -0
- package/assets/docs/tree/block-template.doc.mjs +130 -0
- package/assets/docs/tree/build-the-template.doc.mjs +28 -0
- package/assets/docs/tree/building-blocks.doc.mjs +46 -0
- package/assets/docs/tree/check-your-docs.doc.mjs +137 -0
- package/assets/docs/tree/checks.doc.mjs +119 -0
- package/assets/docs/tree/codemods.doc.mjs +147 -0
- package/assets/docs/tree/component-family.doc.mjs +113 -0
- package/assets/docs/tree/component-imports.doc.mjs +69 -0
- package/assets/docs/tree/component-lookups.doc.mjs +149 -0
- package/assets/docs/tree/components.doc.mjs +23 -0
- package/assets/docs/tree/configuration.doc.mjs +23 -0
- package/assets/docs/tree/debug-and-gap-reports.doc.mjs +182 -0
- package/assets/docs/tree/define-the-theme.doc.mjs +118 -0
- package/assets/docs/tree/describe-the-component.doc.mjs +57 -0
- package/assets/docs/tree/docs.doc.mjs +21 -0
- package/assets/docs/tree/document-the-template.doc.mjs +28 -0
- package/assets/docs/tree/document-the-theme.doc.mjs +68 -0
- package/assets/docs/tree/export-template-assets.doc.mjs +147 -0
- package/assets/docs/tree/extend-or-replace.doc.mjs +103 -0
- package/assets/docs/tree/fonts-and-assets.doc.mjs +106 -0
- package/assets/docs/tree/generate-a-palette.doc.mjs +66 -0
- package/assets/docs/tree/grade-template-with-agent.doc.mjs +105 -0
- package/assets/docs/tree/help.doc.mjs +16 -0
- package/assets/docs/tree/integrations.doc.mjs +25 -451
- package/assets/docs/tree/links.doc.mjs +98 -0
- package/assets/docs/tree/package-and-test.doc.mjs +32 -0
- package/assets/docs/tree/page-template.doc.mjs +71 -0
- package/assets/docs/tree/publishing.doc.mjs +111 -0
- package/assets/docs/tree/quick-start.doc.mjs +272 -0
- package/assets/docs/tree/replace-a-core-component.doc.mjs +104 -0
- package/assets/docs/tree/replace-a-core-template.doc.mjs +172 -0
- package/assets/docs/tree/sections-and-placement.doc.mjs +108 -0
- package/assets/docs/tree/see-it-in-an-app.doc.mjs +59 -0
- package/assets/docs/tree/ship.doc.mjs +16 -0
- package/assets/docs/tree/short-and-findable.doc.mjs +108 -0
- package/assets/docs/tree/single-component.doc.mjs +165 -0
- package/assets/docs/tree/start-a-template.doc.mjs +143 -0
- package/assets/docs/tree/subcomponent.doc.mjs +115 -0
- package/assets/docs/tree/template-assets.doc.mjs +64 -0
- package/assets/docs/tree/template-doc-overview.doc.mjs +121 -0
- package/assets/docs/tree/template-fonts.doc.mjs +102 -0
- package/assets/docs/tree/template-grading-rubric.doc.mjs +452 -0
- package/assets/docs/tree/template-icons.doc.mjs +97 -0
- package/assets/docs/tree/template-images-media.doc.mjs +127 -0
- package/assets/docs/tree/template-styles.doc.mjs +93 -0
- package/assets/docs/tree/templates.doc.mjs +34 -0
- package/assets/docs/tree/test-in-an-app.doc.mjs +115 -0
- package/assets/docs/tree/test-template-in-app.doc.mjs +128 -0
- package/assets/docs/tree/themes.doc.mjs +39 -0
- package/assets/docs/tree/troubleshooting.doc.mjs +153 -0
- package/assets/docs/tree/upgrading.doc.mjs +103 -0
- package/assets/docs/tree/use-a-theme-in-an-app.doc.mjs +51 -0
- package/assets/docs/tree/verify-packed-template.doc.mjs +77 -0
- package/assets/docs/tree/versioning.doc.mjs +162 -0
- package/assets/docs/tree/write-good-templates.doc.mjs +64 -0
- package/assets/docs/tree/write-the-template-file.doc.mjs +154 -0
- package/assets/docs/typography.doc.mjs +24 -4
- package/assets/docs/working-with-ai.doc.mjs +30 -22
- package/assets/templates/blocks/components/InternationalizationProvider/InternationalizationProvider01ShippedLocale.tsx +1 -1
- package/assets/templates/pages/ai-chat/template.doc.mjs +16 -1
- package/assets/templates/pages/ai-chat-landing/template.doc.mjs +9 -1
- package/assets/templates/pages/blank/template.doc.mjs +3 -1
- package/assets/templates/pages/canvas-editor/template.doc.mjs +9 -1
- package/assets/templates/pages/centered-hero/template.doc.mjs +3 -1
- package/assets/templates/pages/checkout-wizard/template.doc.mjs +1 -0
- package/assets/templates/pages/classic-gallery/template.doc.mjs +3 -1
- package/assets/templates/pages/contact-form/template.doc.mjs +16 -1
- package/assets/templates/pages/dashboard/template.doc.mjs +15 -1
- package/assets/templates/pages/dashboard-alert-rail/template.doc.mjs +23 -1
- package/assets/templates/pages/dashboard-cohort-funnel/template.doc.mjs +10 -1
- package/assets/templates/pages/dashboard-comparison/template.doc.mjs +9 -1
- package/assets/templates/pages/dashboard-composition/template.doc.mjs +10 -1
- package/assets/templates/pages/dashboard-progress/template.doc.mjs +17 -1
- package/assets/templates/pages/dashboard-scorecard/template.doc.mjs +2 -1
- package/assets/templates/pages/detail-page/template.doc.mjs +8 -0
- package/assets/templates/pages/documentation/template.doc.mjs +10 -1
- package/assets/templates/pages/documentation-design/template.doc.mjs +10 -1
- package/assets/templates/pages/documentation-technical/template.doc.mjs +10 -1
- package/assets/templates/pages/editor/template.doc.mjs +9 -1
- package/assets/templates/pages/file-explorer/template.doc.mjs +3 -1
- package/assets/templates/pages/form-two-column/template.doc.mjs +17 -1
- package/assets/templates/pages/form-wizard/template.doc.mjs +14 -1
- package/assets/templates/pages/form-wizard-dialog/template.doc.mjs +1 -0
- package/assets/templates/pages/gallery-hero/template.doc.mjs +10 -1
- package/assets/templates/pages/ide/template.doc.mjs +9 -1
- package/assets/templates/pages/incident-console/template.doc.mjs +10 -1
- package/assets/templates/pages/kanban-board/template.doc.mjs +11 -1
- package/assets/templates/pages/library/template.doc.mjs +15 -1
- package/assets/templates/pages/login/template.doc.mjs +10 -1
- package/assets/templates/pages/login-card/template.doc.mjs +11 -1
- package/assets/templates/pages/login-split/template.doc.mjs +10 -1
- package/assets/templates/pages/login-sso/template.doc.mjs +10 -1
- package/assets/templates/pages/messaging-shell/template.doc.mjs +11 -1
- package/assets/templates/pages/mixed-gallery/template.doc.mjs +10 -1
- package/assets/templates/pages/payment-form/template.doc.mjs +3 -1
- package/assets/templates/pages/product-detail/template.doc.mjs +9 -1
- package/assets/templates/pages/product-gallery/template.doc.mjs +10 -1
- package/assets/templates/pages/settings/template.doc.mjs +3 -1
- package/assets/templates/pages/settings-dialog/template.doc.mjs +9 -1
- package/assets/templates/pages/settings-sidebar/template.doc.mjs +9 -1
- package/assets/templates/pages/shell-nav/template.doc.mjs +10 -1
- package/assets/templates/pages/shell-side-nav/template.doc.mjs +14 -1
- package/assets/templates/pages/shell-top-nav/template.doc.mjs +11 -1
- package/assets/templates/pages/side-gallery/template.doc.mjs +3 -1
- package/assets/templates/pages/table/template.doc.mjs +11 -1
- package/assets/templates/pages/table-filter/template.doc.mjs +21 -1
- package/assets/templates/pages/table-grouped/template.doc.mjs +15 -1
- package/assets/templates/pages/table-inbox/template.doc.mjs +18 -6
- package/assets/templates/pages/table-page/template.doc.mjs +20 -1
- package/assets/templates/pages/table-tree/template.doc.mjs +14 -1
- package/assets/templates/pages/theme-showcase/template.doc.mjs +10 -1
- package/assets/templates/pages/work-item-detail/template.doc.mjs +10 -0
- package/assets/templates/themes/butter/icons.tsx +2 -0
- package/assets/templates/themes/chocolate/icons.tsx +2 -0
- package/assets/templates/themes/gothic/icons.tsx +2 -0
- package/assets/templates/themes/matcha/icons.tsx +2 -0
- package/assets/templates/themes/neutral/icons.tsx +2 -0
- package/assets/templates/themes/stone/icons.tsx +2 -0
- package/assets/templates/themes/y2k/icons.tsx +2 -0
- package/authoring/config/config.doc.mjs +9 -1
- package/authoring/config/parse.d.mts +2 -0
- package/authoring/config/parse.mjs +19 -0
- package/authoring/config/parse.test.mjs +8 -0
- package/authoring/config/type.ts +11 -0
- package/authoring/discover/discover.doc.d.mts +13 -0
- package/authoring/discover/discover.doc.mjs +138 -0
- package/authoring/discover/parse.d.mts +24 -0
- package/authoring/discover/parse.mjs +128 -0
- package/authoring/discover/parse.test.mjs +124 -0
- package/authoring/discover/type.ts +87 -0
- package/authoring/doctypes/_schema.d.mts +3 -2
- package/authoring/doctypes/_schema.mjs +6 -0
- package/authoring/doctypes/base/graph-fields.doc.mjs +3 -3
- package/authoring/doctypes/base/type.ts +4 -2
- package/authoring/doctypes/component/component.doc.mjs +6 -0
- package/authoring/doctypes/component/type.ts +8 -0
- package/authoring/doctypes/reference/reference.doc.mjs +7 -0
- package/authoring/doctypes/reference/type.ts +5 -0
- package/authoring/doctypes/schema/schema.doc.mjs +2 -2
- package/authoring/doctypes/template/parse.d.mts +2 -0
- package/authoring/doctypes/template/parse.mjs +1 -0
- package/authoring/doctypes/template/parse.test.mjs +21 -0
- package/authoring/doctypes/template/template.doc.mjs +7 -1
- package/authoring/doctypes/template/type.ts +12 -2
- package/authoring/index.d.mts +1 -0
- package/authoring/index.d.ts +10 -0
- package/authoring/index.mjs +1 -0
- package/authoring/integration/integration.doc.mjs +12 -10
- package/clients/cli/commands/component/index.mjs +152 -55
- package/clients/cli/commands/component-batch.test.mjs +341 -0
- package/clients/cli/commands/component-ownership.test.mjs +89 -0
- package/clients/cli/commands/component.doc.mjs +27 -9
- package/clients/cli/commands/discover.doc.mjs +53 -9
- package/clients/cli/commands/discover.mjs +393 -118
- package/clients/cli/commands/discover.sources.test.mjs +267 -0
- package/clients/cli/commands/docs.doc.mjs +1 -1
- package/clients/cli/commands/docs.mjs +60 -17
- package/clients/cli/commands/docs.test.mjs +113 -24
- package/clients/cli/commands/doctor-integration-docs.doc.mjs +3 -2
- package/clients/cli/commands/doctor-integration.test.mjs +53 -0
- package/clients/cli/commands/doctor.doc.mjs +3 -1
- package/clients/cli/commands/doctor.mjs +53 -9
- package/clients/cli/commands/gap-report.doc.mjs +10 -9
- package/clients/cli/commands/init.doc.mjs +9 -6
- package/clients/cli/commands/integration-add.doc.mjs +17 -7
- package/clients/cli/commands/integration-authoring.test.mjs +70 -9
- package/clients/cli/commands/integration-pack.doc.mjs +5 -9
- package/clients/cli/commands/integration-real-world.test.mjs +1 -1
- package/clients/cli/commands/integration-verify.doc.mjs +22 -0
- package/clients/cli/commands/integration.doc.mjs +4 -4
- package/clients/cli/commands/integration.mjs +76 -43
- package/clients/cli/commands/layout-expand.doc.mjs +3 -1
- package/clients/cli/commands/layout.expand-receipt.test.mjs +94 -0
- package/clients/cli/commands/layout.mjs +16 -0
- package/clients/cli/commands/manifest.doc.mjs +1 -1
- package/clients/cli/commands/search.doc.mjs +10 -3
- package/clients/cli/commands/search.mjs +21 -2
- package/clients/cli/commands/search.test.mjs +21 -4
- package/clients/cli/commands/swizzle.doc.mjs +1 -1
- package/clients/cli/commands/template.copy-receipt.test.mjs +60 -0
- package/clients/cli/commands/template.doc.mjs +1 -1
- package/clients/cli/commands/template.mjs +19 -5
- package/clients/cli/commands/template.show-media.test.mjs +62 -0
- package/clients/cli/commands/text-json-parity.test.mjs +7 -1
- package/clients/cli/commands/theme-add.doc.mjs +1 -1
- package/clients/cli/commands/theme-palette-generate.doc.mjs +3 -2
- package/clients/cli/commands/theme-palette.doc.mjs +1 -2
- package/clients/cli/commands/theme-targets.doc.mjs +2 -2
- package/clients/cli/commands/theme.doc.mjs +2 -1
- package/clients/cli/commands/upgrade.ascii-output.test.mjs +14 -0
- package/clients/cli/commands/upgrade.doc.mjs +62 -3
- package/clients/cli/commands/write-failure.test.mjs +175 -0
- package/clients/cli/index.mjs +28 -6
- package/clients/cli/lib/define-command.mjs +28 -4
- package/clients/cli/lib/define-command.test.mjs +54 -0
- package/clients/cli/lib/exit-codes.test.mjs +17 -1
- package/clients/cli/lib/json-shim.mjs +24 -14
- package/clients/cli/lib/manifest.mjs +48 -156
- package/clients/cli/lib/manifest.test.mjs +103 -9
- package/clients/cli/lib/parse-error-format.test.mjs +81 -0
- package/foundation/agent-docs/agent-docs.mjs +1 -1
- package/foundation/agent-docs/agent-docs.test.mjs +3 -2
- package/foundation/discovery/authoring-self-docs.mjs +1 -0
- package/foundation/discovery/authoring-self-docs.test.mjs +6 -2
- package/foundation/discovery/cli-self-docs.mjs +16 -2
- package/foundation/discovery/cli-self-docs.test.mjs +20 -0
- package/foundation/discovery/docs-discovery.mjs +5 -1
- package/foundation/discovery/docs-discovery.test.mjs +21 -0
- package/foundation/discovery/docs-section-key.d.mts +1 -1
- package/foundation/discovery/docs-section-key.mjs +1 -1
- package/foundation/discovery/template-adapter.d.mts +14 -0
- package/foundation/discovery/template-adapter.fixture-refs.test.mjs +37 -1
- package/foundation/discovery/template-adapter.mjs +21 -1
- package/foundation/doc-compiler/doc-loads.test.mjs +5 -4
- package/foundation/doc-compiler/inputs.test.mjs +0 -1
- package/foundation/doc-compiler/tree.d.mts +4 -0
- package/foundation/doc-compiler/tree.mjs +6 -1
- package/foundation/doc-compiler/tree.test.mjs +65 -14
- package/foundation/integrations/cli-requirement.d.mts +75 -11
- package/foundation/integrations/cli-requirement.mjs +120 -23
- package/foundation/integrations/cli-requirement.test.mjs +141 -9
- package/foundation/integrations/contribution-inventory.mjs +1 -1
- package/foundation/integrations/integrations.d.mts +14 -1
- package/foundation/integrations/integrations.mjs +41 -1
- package/foundation/integrations/integrations.test.mjs +31 -0
- package/foundation/response/batch.type.d.mts +33 -0
- package/foundation/response/batch.type.mjs +34 -0
- package/foundation/response/error-codes.doc.mjs +6 -8
- package/foundation/response/error-codes.test.mjs +30 -5
- package/foundation/response/response-types.doc.d.mts +5 -4
- package/foundation/response/response-types.doc.mjs +49 -19
- package/foundation/response/response-types.doc.test.mjs +23 -0
- package/foundation/response/response.doc.mjs +11 -10
- package/package.json +9 -9
- package/assets/docs/tree/integrations.test.mjs +0 -62
- package/assets/docs/tree/writing-docs.doc.mjs +0 -286
|
@@ -8,6 +8,7 @@ export const docs = {
|
|
|
8
8
|
category: 'guide',
|
|
9
9
|
description:
|
|
10
10
|
'How to set up AI coding tools to generate correct component code.',
|
|
11
|
+
keywords: ['claude', 'cursor', 'codex', 'copilot', 'agents', 'mcp'],
|
|
11
12
|
|
|
12
13
|
sections: [
|
|
13
14
|
{
|
|
@@ -24,7 +25,8 @@ export const docs = {
|
|
|
24
25
|
],
|
|
25
26
|
},
|
|
26
27
|
{
|
|
27
|
-
|
|
28
|
+
id: 'quick-start',
|
|
29
|
+
title: 'Set up agent docs',
|
|
28
30
|
content: [
|
|
29
31
|
{
|
|
30
32
|
type: 'prose',
|
|
@@ -38,7 +40,7 @@ export const docs = {
|
|
|
38
40
|
},
|
|
39
41
|
{
|
|
40
42
|
type: 'prose',
|
|
41
|
-
text: "That's it. The `init --features agents` command generates everything your AI needs (component index, behavioral rules, CLI reference, and package guidance from configured integrations) from the installed project. After a dependency bump, `astryx upgrade
|
|
43
|
+
text: "That's it. The `init --features agents` command generates everything your AI needs (component index, behavioral rules, CLI reference, and package guidance from configured integrations) from the installed project. After a dependency bump, `astryx upgrade --from <old version>` reports a stale block and adding `--apply` refreshes it.",
|
|
42
44
|
},
|
|
43
45
|
{
|
|
44
46
|
type: 'prose',
|
|
@@ -48,10 +50,12 @@ export const docs = {
|
|
|
48
50
|
type: 'code',
|
|
49
51
|
lang: 'bash',
|
|
50
52
|
label: 'Manual options',
|
|
51
|
-
code: `npx @astryxdesign/cli init --features agents --agent claude # .claude/CLAUDE.md
|
|
52
|
-
npx @astryxdesign/cli init --features agents --agent cursor # .cursorrules
|
|
53
|
+
code: `npx @astryxdesign/cli init --features agents --agent claude # CLAUDE.md if present, else .claude/CLAUDE.md
|
|
54
|
+
npx @astryxdesign/cli init --features agents --agent cursor # .cursorrules if present, else AGENTS.md
|
|
53
55
|
npx @astryxdesign/cli init --features agents --agent codex # AGENTS.md (Copilot, Codex, etc.)
|
|
54
|
-
npx @astryxdesign/cli init --features agents --agent
|
|
56
|
+
npx @astryxdesign/cli init --features agents --agent hermes # .hermes.md or HERMES.md if present, else AGENTS.md
|
|
57
|
+
npx @astryxdesign/cli init --features agents --agent muse # AGENTS.md (Muse)
|
|
58
|
+
npx @astryxdesign/cli init --features agents --agent all # every agent file present, else AGENTS.md and .claude/CLAUDE.md`,
|
|
55
59
|
},
|
|
56
60
|
],
|
|
57
61
|
},
|
|
@@ -82,14 +86,17 @@ npx @astryxdesign/cli init --features agents --agent muse # AGENTS.md (Muse
|
|
|
82
86
|
content: [
|
|
83
87
|
{
|
|
84
88
|
type: 'prose',
|
|
85
|
-
text: 'Cursor project rules
|
|
89
|
+
text: 'Cursor reads project rules from `.cursor/rules/`. To keep the Astryx context in a rule of its own, write it there. Give a path relative to the project root, such as `.cursor/rules/astryx.mdc`; an absolute path is refused.',
|
|
86
90
|
},
|
|
87
91
|
{
|
|
88
92
|
type: 'code',
|
|
89
93
|
lang: 'bash',
|
|
90
|
-
label: 'Install as a Cursor
|
|
91
|
-
code: `
|
|
92
|
-
|
|
94
|
+
label: 'Install as a Cursor project rule',
|
|
95
|
+
code: `npx @astryxdesign/cli init --features agents --agent-docs-path .cursor/rules/astryx.mdc`,
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
type: 'prose',
|
|
99
|
+
text: 'Rerunning the same command rewrites only the Astryx block, so frontmatter you add above it (such as `alwaysApply: true`) stays.',
|
|
93
100
|
},
|
|
94
101
|
],
|
|
95
102
|
},
|
|
@@ -98,7 +105,7 @@ npx @astryxdesign/cli init --features agents --agent-docs-path ~/.cursor/rules/x
|
|
|
98
105
|
content: [
|
|
99
106
|
{
|
|
100
107
|
type: 'prose',
|
|
101
|
-
text: 'Paste this into your AI before writing any component code.
|
|
108
|
+
text: 'Paste this into your AI before writing any component code. If your AI can\'t answer these questions, it\'ll know to install the agent docs first.',
|
|
102
109
|
},
|
|
103
110
|
{
|
|
104
111
|
type: 'code',
|
|
@@ -107,7 +114,7 @@ npx @astryxdesign/cli init --features agents --agent-docs-path ~/.cursor/rules/x
|
|
|
107
114
|
code: `Before writing any Astryx code, check your knowledge:
|
|
108
115
|
|
|
109
116
|
1. What is the correct import path for Button?
|
|
110
|
-
2. How do you make
|
|
117
|
+
2. How do you make a Dialog non-dismissible?
|
|
111
118
|
3. What prop does Selector use for its items?
|
|
112
119
|
|
|
113
120
|
If you don't know all three, run \`npx @astryxdesign/cli init --features agents\` to generate agent docs, then read the generated file.`,
|
|
@@ -131,33 +138,34 @@ If you don't know all three, run \`npx @astryxdesign/cli init --features agents\
|
|
|
131
138
|
},
|
|
132
139
|
{
|
|
133
140
|
type: 'prose',
|
|
134
|
-
text: 'With this alias, agents
|
|
141
|
+
text: 'With this alias, agents run `npm run astryx -- component --list` instead of guessing the binary path. The `--` separator is standard npm convention for passing flags to scripts.',
|
|
135
142
|
},
|
|
136
143
|
{
|
|
137
144
|
type: 'code',
|
|
138
145
|
lang: 'bash',
|
|
139
146
|
label: 'Reliable CLI invocation',
|
|
140
|
-
code: `astryx component --list
|
|
141
|
-
astryx component Dialog --dense
|
|
142
|
-
astryx docs styling --
|
|
143
|
-
astryx docs tokens --dense`,
|
|
147
|
+
code: `npm run astryx -- component --list
|
|
148
|
+
npm run astryx -- component Dialog --dense
|
|
149
|
+
npm run astryx -- docs styling --full --detail brief
|
|
150
|
+
npm run astryx -- docs tokens --dense`,
|
|
144
151
|
},
|
|
145
152
|
],
|
|
146
153
|
},
|
|
147
154
|
{
|
|
148
|
-
|
|
155
|
+
id: 'the-dense-flag',
|
|
156
|
+
title: 'Shorter output: --detail and --dense',
|
|
149
157
|
content: [
|
|
150
158
|
{
|
|
151
159
|
type: 'prose',
|
|
152
|
-
text: '
|
|
160
|
+
text: 'For a shorter read, add `--detail brief` (one line per section) or `--detail compact`. `--dense` swaps in a shorter text where a doc ships one. Use them when pasting CLI output into a web-based AI tool like ChatGPT or Claude.',
|
|
153
161
|
},
|
|
154
162
|
{
|
|
155
163
|
type: 'code',
|
|
156
164
|
lang: 'bash',
|
|
157
|
-
label: '
|
|
158
|
-
code: `astryx
|
|
159
|
-
astryx
|
|
160
|
-
astryx docs
|
|
165
|
+
label: 'Short output for pasting into AI conversations',
|
|
166
|
+
code: `astryx docs styling --full --detail brief
|
|
167
|
+
astryx component Dialog --detail compact
|
|
168
|
+
astryx docs principles --dense`,
|
|
161
169
|
},
|
|
162
170
|
],
|
|
163
171
|
},
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
import {useState} from 'react';
|
|
6
6
|
import {InternationalizationProvider} from '@astryxdesign/core/i18n';
|
|
7
|
-
import frFR from '@astryxdesign/core/locales/fr-FR.
|
|
7
|
+
import frFR from '@astryxdesign/core/locales/fr-FR.generated.js';
|
|
8
8
|
import {Stack} from '@astryxdesign/core/Layout';
|
|
9
9
|
import {
|
|
10
10
|
SegmentedControl,
|
|
@@ -5,7 +5,22 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'AI Chat Conversation',
|
|
7
7
|
displayName: 'AI Chat Conversation',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Transcript of alternating turns carrying mixed rich content inline (markdown, code blocks, collapsible tool-call output) beside a resizable artifact panel that holds generated output while the stream keeps scrolling.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'chat',
|
|
12
|
+
'conversation',
|
|
13
|
+
'assistant',
|
|
14
|
+
'messages',
|
|
15
|
+
'copilot thread',
|
|
16
|
+
'agent',
|
|
17
|
+
'session',
|
|
18
|
+
'composer',
|
|
19
|
+
'questions',
|
|
20
|
+
'answers with citations',
|
|
21
|
+
'reasoning trace',
|
|
22
|
+
'prompt playground',
|
|
23
|
+
],
|
|
9
24
|
isReady: true,
|
|
10
25
|
category: 'AI Chat - Conversation',
|
|
11
26
|
};
|
|
@@ -5,7 +5,15 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'AI Chat Landing',
|
|
7
7
|
displayName: 'AI Chat Landing',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Zero-state entry surface centered on a single composer with suggestion chips instead of history, sized for the moment before any content exists. The empty counterpart to a transcript.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'chat',
|
|
12
|
+
'conversation',
|
|
13
|
+
'assistant',
|
|
14
|
+
'prompt',
|
|
15
|
+
'messages launcher',
|
|
16
|
+
],
|
|
9
17
|
isReady: true,
|
|
10
18
|
category: 'AI Chat - Landing',
|
|
11
19
|
};
|
|
@@ -5,7 +5,9 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Blank',
|
|
7
7
|
displayName: 'Blank',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Bare scaffold: one heading slot, one empty content region, no navigation and no chrome. The starting point when every other layout imposes more structure than wanted.',
|
|
10
|
+
keywords: ['blank', 'empty', 'stub', 'placeholder', 'minimal scaffold'],
|
|
9
11
|
isReady: true,
|
|
10
12
|
scaffold: true,
|
|
11
13
|
category: 'Shell - Blank',
|
|
@@ -6,7 +6,15 @@ export const doc = {
|
|
|
6
6
|
name: 'Canvas Editor',
|
|
7
7
|
displayName: 'Canvas Editor',
|
|
8
8
|
description:
|
|
9
|
-
'Layered artboard workspace: document tabs over a layer rail, a fixed-size frame you zoom on a muted backdrop, and an inspector of position, type, and filter fields that retargets to the selected layer. Objects hold a coordinate rather than reflowing, so moving one never moves another.
|
|
9
|
+
'Layered artboard workspace: document tabs over a layer rail, a fixed-size frame you zoom on a muted backdrop, and an inspector of position, type, and filter fields that retargets to the selected layer. Objects hold a coordinate rather than reflowing, so moving one never moves another.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'design tool',
|
|
12
|
+
'artboard',
|
|
13
|
+
'poster',
|
|
14
|
+
'graphic',
|
|
15
|
+
'image',
|
|
16
|
+
'slide editor',
|
|
17
|
+
],
|
|
10
18
|
isReady: true,
|
|
11
19
|
category: 'Tools - Canvas Editor',
|
|
12
20
|
};
|
|
@@ -5,7 +5,9 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Centered Hero',
|
|
7
7
|
displayName: 'Centered Hero',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Symmetrical centered stack (headline, short blurb, paired call-to-action buttons) resting on one wide full-bleed picture, with nothing on either flank competing.',
|
|
10
|
+
keywords: ['hero', 'banner', 'splash', 'landing image', 'marketing masthead'],
|
|
9
11
|
isReady: true,
|
|
10
12
|
category: 'Gallery - Hero',
|
|
11
13
|
};
|
|
@@ -7,6 +7,7 @@ export const doc = {
|
|
|
7
7
|
displayName: 'Checkout Wizard',
|
|
8
8
|
description:
|
|
9
9
|
'Multi-step checkout, cart, order, and payment wizard with a running summary that recalculates as answers change. It adapts to its host width, renders the summary first on narrow surfaces, validates every forward path, and completes locally without sending payment.',
|
|
10
|
+
keywords: ['checkout', 'cart', 'order', 'payment'],
|
|
10
11
|
isReady: true,
|
|
11
12
|
category: 'Form - Checkout',
|
|
12
13
|
};
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
export const doc = {
|
|
5
5
|
name: 'Classic Gallery',
|
|
6
6
|
displayName: 'Classic Gallery',
|
|
7
|
-
description:
|
|
7
|
+
description:
|
|
8
|
+
'Uniform grid of equal-ratio media tiles under a centered intro, with filter tabs that narrow the set in place. Regular rhythm, unlike the variable-height masonry variant.',
|
|
9
|
+
keywords: ['gallery', 'photos', 'images', 'pictures', 'portfolio index'],
|
|
8
10
|
type: 'page',
|
|
9
11
|
isReady: true,
|
|
10
12
|
category: 'Gallery - Basic',
|
|
@@ -5,7 +5,22 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Contact Form',
|
|
7
7
|
displayName: 'Contact Form',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Flat single-column form mixing control types (text, pill toggles, dropdowns, long free-text) landing on one full-width submit. No steps, no branching, no summary rail.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'contact',
|
|
12
|
+
'lead capture',
|
|
13
|
+
'enquiry',
|
|
14
|
+
'survey',
|
|
15
|
+
'intake form',
|
|
16
|
+
'questionnaire',
|
|
17
|
+
'feedback',
|
|
18
|
+
'request',
|
|
19
|
+
'submission',
|
|
20
|
+
'entry',
|
|
21
|
+
'fields',
|
|
22
|
+
'upload',
|
|
23
|
+
],
|
|
9
24
|
isReady: true,
|
|
10
25
|
category: 'Form - Basic',
|
|
11
26
|
};
|
|
@@ -6,7 +6,21 @@ export const doc = {
|
|
|
6
6
|
name: 'Analytics Dashboard',
|
|
7
7
|
displayName: 'Analytics Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Three-band analytics: a row of headline tiles, then charts, then supporting tables, all re-reading from one global filter bar. Breadth over depth, a summary surface rather than a drill-down.
|
|
9
|
+
'Three-band analytics: a row of headline tiles, then charts, then supporting tables, all re-reading from one global filter bar. Breadth over depth, a summary surface rather than a drill-down.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'dashboard',
|
|
12
|
+
'overview',
|
|
13
|
+
'metrics',
|
|
14
|
+
'stats',
|
|
15
|
+
'analytics',
|
|
16
|
+
'reporting',
|
|
17
|
+
'insights',
|
|
18
|
+
'kpi tiles',
|
|
19
|
+
'widgets',
|
|
20
|
+
'donut charts',
|
|
21
|
+
'breakdowns',
|
|
22
|
+
'forecasts',
|
|
23
|
+
],
|
|
10
24
|
isReady: true,
|
|
11
25
|
category: 'Dashboard - Analytics',
|
|
12
26
|
};
|
|
@@ -6,7 +6,29 @@ export const doc = {
|
|
|
6
6
|
name: 'Service Monitoring Dashboard',
|
|
7
7
|
displayName: 'Service Monitoring Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Always-on analytics with a triage rail: status-colored tiles with sparklines, multi-series time charts over a switchable window, and an independently scrolling alert column that folds into the content when narrow.
|
|
9
|
+
'Always-on analytics with a triage rail: status-colored tiles with sparklines, multi-series time charts over a switchable window, and an independently scrolling alert column that folds into the content when narrow.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'monitoring',
|
|
12
|
+
'uptime',
|
|
13
|
+
'health',
|
|
14
|
+
'latency',
|
|
15
|
+
'alerting',
|
|
16
|
+
'incidents',
|
|
17
|
+
'observability',
|
|
18
|
+
'operations',
|
|
19
|
+
'live status',
|
|
20
|
+
'real-time',
|
|
21
|
+
'reliability',
|
|
22
|
+
'traffic',
|
|
23
|
+
'anomalies',
|
|
24
|
+
'severity',
|
|
25
|
+
'on-call',
|
|
26
|
+
'oncall',
|
|
27
|
+
'fleet',
|
|
28
|
+
'pipelines',
|
|
29
|
+
'freshness',
|
|
30
|
+
'command center',
|
|
31
|
+
],
|
|
10
32
|
isReady: true,
|
|
11
33
|
category: 'Dashboard - Monitoring',
|
|
12
34
|
};
|
|
@@ -6,7 +6,16 @@ export const doc = {
|
|
|
6
6
|
name: 'Funnel & Cohort Dashboard',
|
|
7
7
|
displayName: 'Funnel & Cohort Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Analytics for sequence and retention questions, pairing two shapes a plain dashboard cannot hold: a staged funnel where each step reads as drop-off against the one before, and a two-axis cohort matrix rendered as a heatmap.
|
|
9
|
+
'Analytics for sequence and retention questions, pairing two shapes a plain dashboard cannot hold: a staged funnel where each step reads as drop-off against the one before, and a two-axis cohort matrix rendered as a heatmap.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'conversion',
|
|
12
|
+
'drop-off',
|
|
13
|
+
'activation',
|
|
14
|
+
'churn',
|
|
15
|
+
'retention reporting',
|
|
16
|
+
'stages',
|
|
17
|
+
'segments',
|
|
18
|
+
],
|
|
10
19
|
isReady: true,
|
|
11
20
|
category: 'Dashboard - Funnel & Cohort',
|
|
12
21
|
};
|
|
@@ -6,7 +6,15 @@ export const doc = {
|
|
|
6
6
|
name: 'Data Dashboard',
|
|
7
7
|
displayName: 'Data Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Comparison-heavy analytics behind a persistent filter bar: tiles that each carry an inline sparkline and several period-over-period deltas, then segmented breakdowns underneath. Every number is shown against another number.
|
|
9
|
+
'Comparison-heavy analytics behind a persistent filter bar: tiles that each carry an inline sparkline and several period-over-period deltas, then segmented breakdowns underneath. Every number is shown against another number.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'dashboard',
|
|
12
|
+
'metrics',
|
|
13
|
+
'stats',
|
|
14
|
+
'analytics',
|
|
15
|
+
'trends',
|
|
16
|
+
'reporting',
|
|
17
|
+
],
|
|
10
18
|
isReady: true,
|
|
11
19
|
category: 'Dashboard - Comparison',
|
|
12
20
|
};
|
|
@@ -6,7 +6,16 @@ export const doc = {
|
|
|
6
6
|
name: 'Portfolio Dashboard',
|
|
7
7
|
displayName: 'Portfolio Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Analytics for a value-over-time question: balance and change tiles above a stacked area chart of composition through time, closing on a ranked table of the largest contributors.
|
|
9
|
+
'Analytics for a value-over-time question: balance and change tiles above a stacked area chart of composition through time, closing on a ranked table of the largest contributors.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'portfolio',
|
|
12
|
+
'holdings',
|
|
13
|
+
'positions',
|
|
14
|
+
'returns',
|
|
15
|
+
'allocation',
|
|
16
|
+
'investments',
|
|
17
|
+
'performance reporting',
|
|
18
|
+
],
|
|
10
19
|
isReady: true,
|
|
11
20
|
category: 'Dashboard - Portfolio',
|
|
12
21
|
};
|
|
@@ -6,7 +6,23 @@ export const doc = {
|
|
|
6
6
|
name: 'Project Status Dashboard',
|
|
7
7
|
displayName: 'Project Status Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Status analytics mixing progress and time-axis shapes: a completion donut, a horizontal timeline of dated bars against a today marker, a per-owner table with progress and status, an at-risk list, and a burndown.
|
|
9
|
+
'Status analytics mixing progress and time-axis shapes: a completion donut, a horizontal timeline of dated bars against a today marker, a per-owner table with progress and status, an at-risk list, and a burndown.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'project',
|
|
12
|
+
'program',
|
|
13
|
+
'milestone',
|
|
14
|
+
'roadmap',
|
|
15
|
+
'launch',
|
|
16
|
+
'delivery status',
|
|
17
|
+
'workstreams and milestones',
|
|
18
|
+
'gates',
|
|
19
|
+
'blockers',
|
|
20
|
+
'gantt',
|
|
21
|
+
'rollout',
|
|
22
|
+
'release planning',
|
|
23
|
+
'readiness',
|
|
24
|
+
'tracker',
|
|
25
|
+
],
|
|
10
26
|
isReady: true,
|
|
11
27
|
category: 'Dashboard - Project Status',
|
|
12
28
|
};
|
|
@@ -6,7 +6,8 @@ export const doc = {
|
|
|
6
6
|
name: 'Executive Summary Dashboard',
|
|
7
7
|
displayName: 'Executive Summary Dashboard',
|
|
8
8
|
description:
|
|
9
|
-
'Report-shaped analytics with a prose rail beside the charts: a scorecard of headline numbers with period deltas and status coloring, goal-attainment bars, a trend grid, and a written commentary column that folds beneath the content when narrow.
|
|
9
|
+
'Report-shaped analytics with a prose rail beside the charts: a scorecard of headline numbers with period deltas and status coloring, goal-attainment bars, a trend grid, and a written commentary column that folds beneath the content when narrow.',
|
|
10
|
+
keywords: ['executive summary', 'business review', 'readout', 'reporting'],
|
|
10
11
|
isReady: true,
|
|
11
12
|
category: 'Dashboard - Scorecard',
|
|
12
13
|
};
|
|
@@ -6,6 +6,14 @@ export const doc = {
|
|
|
6
6
|
name: 'Order Detail',
|
|
7
7
|
displayName: 'Order Detail',
|
|
8
8
|
description: 'Single-record detail in two columns: a summary header with status and actions, a repeating line-item list, a totals block that sums it, and a chronological activity timeline in the rail. The shape for any record holding children plus a history: a customer order with shipping, an invoice, a transaction, or a job.',
|
|
9
|
+
keywords: [
|
|
10
|
+
'order',
|
|
11
|
+
'invoice',
|
|
12
|
+
'transaction',
|
|
13
|
+
'job',
|
|
14
|
+
'record detail',
|
|
15
|
+
'summary header',
|
|
16
|
+
],
|
|
9
17
|
isReady: true,
|
|
10
18
|
category: 'Content - Order Detail',
|
|
11
19
|
};
|
|
@@ -5,7 +5,16 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Documentation Catalog',
|
|
7
7
|
displayName: 'Documentation Catalog',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Reference landing that is pure wayfinding: a banner above a grid of category cards linking into sections, with no article content on the surface itself.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'documentation',
|
|
12
|
+
'docs',
|
|
13
|
+
'guide',
|
|
14
|
+
'handbook',
|
|
15
|
+
'reference',
|
|
16
|
+
'api index',
|
|
17
|
+
],
|
|
9
18
|
isReady: true,
|
|
10
19
|
category: 'Content - Documentation Catalog',
|
|
11
20
|
};
|
|
@@ -5,7 +5,16 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Documentation Design',
|
|
7
7
|
displayName: 'Documentation Design',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Reference article alternating prose with live rendered examples: an interactive preview, a property table, paired do and don\'t comparisons, and copyable code blocks.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'documentation',
|
|
12
|
+
'docs',
|
|
13
|
+
'guide',
|
|
14
|
+
'reference',
|
|
15
|
+
'usage',
|
|
16
|
+
'api entry',
|
|
17
|
+
],
|
|
9
18
|
isReady: true,
|
|
10
19
|
category: 'Content - Documentation Design',
|
|
11
20
|
};
|
|
@@ -5,7 +5,16 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Documentation Technical',
|
|
7
7
|
displayName: 'Documentation Technical',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Reference article ordered as sequential numbered steps with code at each stage, plus callout cards for prerequisites and onward links. A linear walkthrough rather than a browsable reference.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'getting started',
|
|
12
|
+
'install',
|
|
13
|
+
'setup',
|
|
14
|
+
'tutorial',
|
|
15
|
+
'quickstart',
|
|
16
|
+
'onboarding guide',
|
|
17
|
+
],
|
|
9
18
|
isReady: true,
|
|
10
19
|
category: 'Content - Documentation Technical',
|
|
11
20
|
};
|
|
@@ -5,7 +5,15 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Page Editor',
|
|
7
7
|
displayName: 'Page Editor',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Three-pane authoring workspace: a source palette on one flank, a live canvas in the middle, and an inspector that retargets to whatever is selected. Drag and drop to reorder, edit to see it render immediately.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'builder',
|
|
12
|
+
'composer',
|
|
13
|
+
'drag and drop',
|
|
14
|
+
'page builder',
|
|
15
|
+
'wysiwyg editor',
|
|
16
|
+
],
|
|
9
17
|
isReady: true,
|
|
10
18
|
category: 'Tools - Page Editor',
|
|
11
19
|
};
|
|
@@ -5,7 +5,9 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'File Explorer',
|
|
7
7
|
displayName: 'File Explorer',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Hierarchical browser that drills through nested levels as adjacent columns rather than replacing the list each time, with breadcrumb history, switchable list and grid density, and a metadata pane for the selected node.',
|
|
10
|
+
keywords: ['files', 'folders', 'directory', 'tree', 'finder-style navigator'],
|
|
9
11
|
isReady: true,
|
|
10
12
|
category: 'Tools - File Explorer',
|
|
11
13
|
};
|
|
@@ -5,7 +5,23 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Two-column Form',
|
|
7
7
|
displayName: 'Two-column Form',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Form split into two columns beneath a hero header: inputs on one flank, a persistent context panel opposite that stays put while the fields scroll. Flat, single submit, no steps.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'contact',
|
|
12
|
+
'lead capture',
|
|
13
|
+
'intake',
|
|
14
|
+
'request',
|
|
15
|
+
'enquiry form',
|
|
16
|
+
'configurator',
|
|
17
|
+
'generator',
|
|
18
|
+
'launcher',
|
|
19
|
+
'calculator',
|
|
20
|
+
'checklist',
|
|
21
|
+
'upload',
|
|
22
|
+
'live preview',
|
|
23
|
+
'side panel',
|
|
24
|
+
],
|
|
9
25
|
isReady: true,
|
|
10
26
|
category: 'Form - Two-column',
|
|
11
27
|
};
|
|
@@ -6,7 +6,20 @@ export const doc = {
|
|
|
6
6
|
name: 'Form Wizard',
|
|
7
7
|
displayName: 'Form Wizard',
|
|
8
8
|
description:
|
|
9
|
-
'Linear multi-step form that moves through one panel at a time, with a horizontal progress track pinned above rather than running down a rail, so every step keeps the full content width for its fields. Only the current step renders, unlike an accordion where each section expands into one long scrolling form. Each advance is validated, and a step left broken stays flagged to jump back to.
|
|
9
|
+
'Linear multi-step form that moves through one panel at a time, with a horizontal progress track pinned above rather than running down a rail, so every step keeps the full content width for its fields. Only the current step renders, unlike an accordion where each section expands into one long scrolling form. Each advance is validated, and a step left broken stays flagged to jump back to.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'wizard',
|
|
12
|
+
'stepper',
|
|
13
|
+
'multi-step',
|
|
14
|
+
'onboarding',
|
|
15
|
+
'setup',
|
|
16
|
+
'signup',
|
|
17
|
+
'guided flow',
|
|
18
|
+
'step-by-step',
|
|
19
|
+
'workflow',
|
|
20
|
+
'review step',
|
|
21
|
+
'request flow',
|
|
22
|
+
],
|
|
10
23
|
isReady: true,
|
|
11
24
|
category: 'Form - Wizard',
|
|
12
25
|
};
|
|
@@ -7,6 +7,7 @@ export const doc = {
|
|
|
7
7
|
displayName: 'Dialog Wizard',
|
|
8
8
|
description:
|
|
9
9
|
'Step through a short flow in a dialog, overlay, or popup launched from the page underneath, which stays where it was. Compact step markers and a pinned action row inside a constrained width, rather than the full page a wizard usually gets. Best for two to four short steps — setup, invite, schedule, onboarding — where losing the context underneath would cost more than the flow is worth.',
|
|
10
|
+
keywords: ['setup', 'invite', 'schedule', 'onboarding'],
|
|
10
11
|
isReady: true,
|
|
11
12
|
category: 'Form - Wizard Dialog',
|
|
12
13
|
};
|
|
@@ -5,7 +5,16 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Gallery Hero',
|
|
7
7
|
displayName: 'Gallery Hero',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Centered stack (headline, short blurb, call-to-action buttons) resolving into a multi-image photo grid rather than one wide full-bleed picture, so the imagery reads as a set.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'hero',
|
|
12
|
+
'banner',
|
|
13
|
+
'splash',
|
|
14
|
+
'landing image',
|
|
15
|
+
'masthead',
|
|
16
|
+
'gallery intro',
|
|
17
|
+
],
|
|
9
18
|
isReady: true,
|
|
10
19
|
category: 'Gallery - Hero',
|
|
11
20
|
};
|
|
@@ -5,7 +5,15 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'IDE',
|
|
7
7
|
displayName: 'IDE',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Dense multi-pane workspace of resizable, collapsible regions: a hierarchy tree on one flank, tabbed documents in the middle, a docked drawer along the bottom, an inspector opposite. Drag a divider to resize or collapse any of them.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'editor',
|
|
12
|
+
'ide',
|
|
13
|
+
'workbench',
|
|
14
|
+
'terminal',
|
|
15
|
+
'development environment',
|
|
16
|
+
],
|
|
9
17
|
isReady: true,
|
|
10
18
|
category: 'Tools - IDE',
|
|
11
19
|
};
|
|
@@ -5,7 +5,16 @@ export const doc = {
|
|
|
5
5
|
type: 'page',
|
|
6
6
|
name: 'Incident Console',
|
|
7
7
|
displayName: 'Incident Console',
|
|
8
|
-
description:
|
|
8
|
+
description:
|
|
9
|
+
'Dense row queue with an inspector: severity-coded rows grouped by status, a saved-search filter bar, a segmented status control, and a resizable detail pane for the selected row. Rows, not cards, sized for scanning volume.',
|
|
10
|
+
keywords: [
|
|
11
|
+
'incident',
|
|
12
|
+
'alert',
|
|
13
|
+
'on-call',
|
|
14
|
+
'outage',
|
|
15
|
+
'ticket',
|
|
16
|
+
'triage console',
|
|
17
|
+
],
|
|
9
18
|
isReady: false,
|
|
10
19
|
category: 'Tools - Incident Console',
|
|
11
20
|
};
|