@vibesdotdev/docs 0.0.0-stage → 1.0.0-rc.3
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/LICENSE +18 -0
- package/README.md +74 -2
- package/dist/cli/cli.plugin.d.ts +14 -0
- package/dist/cli/cli.plugin.d.ts.map +1 -0
- package/dist/cli/cli.plugin.js +57 -0
- package/dist/cli/cli.plugin.js.map +1 -0
- package/dist/cli/commands/docs.list.command.descriptor.d.ts +33 -0
- package/dist/cli/commands/docs.list.command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/docs.list.command.descriptor.js +34 -0
- package/dist/cli/commands/docs.list.command.descriptor.js.map +1 -0
- package/dist/cli/commands/docs.list.command.impl.d.ts +25 -0
- package/dist/cli/commands/docs.list.command.impl.d.ts.map +1 -0
- package/dist/cli/commands/docs.list.command.impl.js +87 -0
- package/dist/cli/commands/docs.list.command.impl.js.map +1 -0
- package/dist/cli/commands/docs.show.command.descriptor.d.ts +44 -0
- package/dist/cli/commands/docs.show.command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/docs.show.command.descriptor.js +48 -0
- package/dist/cli/commands/docs.show.command.descriptor.js.map +1 -0
- package/dist/cli/commands/docs.show.command.impl.d.ts +26 -0
- package/dist/cli/commands/docs.show.command.impl.d.ts.map +1 -0
- package/dist/cli/commands/docs.show.command.impl.js +82 -0
- package/dist/cli/commands/docs.show.command.impl.js.map +1 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.descriptor.d.ts +4 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.descriptor.js +58 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.descriptor.js.map +1 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.impl.d.ts +24 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.impl.d.ts.map +1 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.impl.js +283 -0
- package/dist/cli/commands/generate/docs.generate.cli-command.impl.js.map +1 -0
- package/dist/cli/commands/man/man.cli-command.descriptor.d.ts +4 -0
- package/dist/cli/commands/man/man.cli-command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/man/man.cli-command.descriptor.js +32 -0
- package/dist/cli/commands/man/man.cli-command.descriptor.js.map +1 -0
- package/dist/cli/commands/man/man.cli-command.impl.d.ts +23 -0
- package/dist/cli/commands/man/man.cli-command.impl.d.ts.map +1 -0
- package/dist/cli/commands/man/man.cli-command.impl.js +22 -0
- package/dist/cli/commands/man/man.cli-command.impl.js.map +1 -0
- package/dist/cli/commands/open/docs.open.cli-command.descriptor.d.ts +4 -0
- package/dist/cli/commands/open/docs.open.cli-command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/open/docs.open.cli-command.descriptor.js +18 -0
- package/dist/cli/commands/open/docs.open.cli-command.descriptor.js.map +1 -0
- package/dist/cli/commands/open/docs.open.cli-command.impl.d.ts +14 -0
- package/dist/cli/commands/open/docs.open.cli-command.impl.d.ts.map +1 -0
- package/dist/cli/commands/open/docs.open.cli-command.impl.js +52 -0
- package/dist/cli/commands/open/docs.open.cli-command.impl.js.map +1 -0
- package/dist/cli/commands/search.command.descriptor.d.ts +36 -0
- package/dist/cli/commands/search.command.descriptor.d.ts.map +1 -0
- package/dist/cli/commands/search.command.descriptor.js +35 -0
- package/dist/cli/commands/search.command.descriptor.js.map +1 -0
- package/dist/cli/commands/search.command.impl.d.ts +25 -0
- package/dist/cli/commands/search.command.impl.d.ts.map +1 -0
- package/dist/cli/commands/search.command.impl.js +113 -0
- package/dist/cli/commands/search.command.impl.js.map +1 -0
- package/dist/cli/directives/card.d.ts +11 -0
- package/dist/cli/directives/card.d.ts.map +1 -0
- package/dist/cli/directives/card.js +18 -0
- package/dist/cli/directives/card.js.map +1 -0
- package/dist/cli/directives/descriptor.d.ts +11 -0
- package/dist/cli/directives/descriptor.d.ts.map +1 -0
- package/dist/cli/directives/descriptor.js +20 -0
- package/dist/cli/directives/descriptor.js.map +1 -0
- package/dist/cli/directives/endpoint.d.ts +8 -0
- package/dist/cli/directives/endpoint.d.ts.map +1 -0
- package/dist/cli/directives/endpoint.js +31 -0
- package/dist/cli/directives/endpoint.js.map +1 -0
- package/dist/cli/directives/index.d.ts +9 -0
- package/dist/cli/directives/index.d.ts.map +1 -0
- package/dist/cli/directives/index.js +37 -0
- package/dist/cli/directives/index.js.map +1 -0
- package/dist/cli/directives/install.d.ts +12 -0
- package/dist/cli/directives/install.d.ts.map +1 -0
- package/dist/cli/directives/install.js +27 -0
- package/dist/cli/directives/install.js.map +1 -0
- package/dist/cli/directives/shell.d.ts +10 -0
- package/dist/cli/directives/shell.d.ts.map +1 -0
- package/dist/cli/directives/shell.js +16 -0
- package/dist/cli/directives/shell.js.map +1 -0
- package/dist/cli/directives/usage.d.ts +9 -0
- package/dist/cli/directives/usage.d.ts.map +1 -0
- package/dist/cli/directives/usage.js +13 -0
- package/dist/cli/directives/usage.js.map +1 -0
- package/dist/cli/docs/docs.cli.docs.descriptor.d.ts +22 -0
- package/dist/cli/docs/docs.cli.docs.descriptor.d.ts.map +1 -0
- package/dist/cli/docs/docs.cli.docs.descriptor.js +92 -0
- package/dist/cli/docs/docs.cli.docs.descriptor.js.map +1 -0
- package/dist/cli/docs.cli-group.descriptor.d.ts +4 -0
- package/dist/cli/docs.cli-group.descriptor.d.ts.map +1 -0
- package/dist/cli/docs.cli-group.descriptor.js +11 -0
- package/dist/cli/docs.cli-group.descriptor.js.map +1 -0
- package/dist/client/citations.d.ts +11 -0
- package/dist/client/citations.d.ts.map +1 -0
- package/dist/client/citations.js +197 -0
- package/dist/client/citations.js.map +1 -0
- package/dist/client/docs-client.d.ts +51 -0
- package/dist/client/docs-client.d.ts.map +1 -0
- package/dist/client/docs-client.js +298 -0
- package/dist/client/docs-client.js.map +1 -0
- package/dist/client/index.d.ts +12 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +13 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.d.ts +26 -0
- package/dist/client/types.d.ts.map +1 -0
- package/dist/client/types.js +2 -0
- package/dist/client/types.js.map +1 -0
- package/dist/config/docs.svelte.config.descriptor.d.ts +50 -0
- package/dist/config/docs.svelte.config.descriptor.d.ts.map +1 -0
- package/dist/config/docs.svelte.config.descriptor.js +46 -0
- package/dist/config/docs.svelte.config.descriptor.js.map +1 -0
- package/dist/config/documents.source-refresh.config.descriptor.d.ts +41 -0
- package/dist/config/documents.source-refresh.config.descriptor.d.ts.map +1 -0
- package/dist/config/documents.source-refresh.config.descriptor.js +39 -0
- package/dist/config/documents.source-refresh.config.descriptor.js.map +1 -0
- package/dist/directives/index.d.ts +4 -0
- package/dist/directives/index.d.ts.map +1 -0
- package/dist/directives/index.js +3 -0
- package/dist/directives/index.js.map +1 -0
- package/dist/directives/registry.d.ts +31 -0
- package/dist/directives/registry.d.ts.map +1 -0
- package/dist/directives/registry.js +65 -0
- package/dist/directives/registry.js.map +1 -0
- package/dist/directives/types.d.ts +33 -0
- package/dist/directives/types.d.ts.map +1 -0
- package/dist/directives/types.js +2 -0
- package/dist/directives/types.js.map +1 -0
- package/dist/docs/agent-voice.docs.descriptor.d.ts +30 -0
- package/dist/docs/agent-voice.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/agent-voice.docs.descriptor.js +107 -0
- package/dist/docs/agent-voice.docs.descriptor.js.map +1 -0
- package/dist/docs/charts.usage.docs.descriptor.d.ts +27 -0
- package/dist/docs/charts.usage.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/charts.usage.docs.descriptor.js +90 -0
- package/dist/docs/charts.usage.docs.descriptor.js.map +1 -0
- package/dist/docs/command-palette.actions.docs.descriptor.d.ts +25 -0
- package/dist/docs/command-palette.actions.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/command-palette.actions.docs.descriptor.js +80 -0
- package/dist/docs/command-palette.actions.docs.descriptor.js.map +1 -0
- package/dist/docs/docs.directives.docs.descriptor.d.ts +22 -0
- package/dist/docs/docs.directives.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/docs.directives.docs.descriptor.js +104 -0
- package/dist/docs/docs.directives.docs.descriptor.js.map +1 -0
- package/dist/docs/docs.topics.docs.descriptor.d.ts +22 -0
- package/dist/docs/docs.topics.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/docs.topics.docs.descriptor.js +90 -0
- package/dist/docs/docs.topics.docs.descriptor.js.map +1 -0
- package/dist/docs/fleet-pairing-direct.docs.descriptor.d.ts +30 -0
- package/dist/docs/fleet-pairing-direct.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/fleet-pairing-direct.docs.descriptor.js +93 -0
- package/dist/docs/fleet-pairing-direct.docs.descriptor.js.map +1 -0
- package/dist/docs/fleet-pairing-mdns.docs.descriptor.d.ts +30 -0
- package/dist/docs/fleet-pairing-mdns.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/fleet-pairing-mdns.docs.descriptor.js +88 -0
- package/dist/docs/fleet-pairing-mdns.docs.descriptor.js.map +1 -0
- package/dist/docs/fleet-pairing-platform.docs.descriptor.d.ts +30 -0
- package/dist/docs/fleet-pairing-platform.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/fleet-pairing-platform.docs.descriptor.js +101 -0
- package/dist/docs/fleet-pairing-platform.docs.descriptor.js.map +1 -0
- package/dist/docs/fleet-pairing.docs.descriptor.d.ts +28 -0
- package/dist/docs/fleet-pairing.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/fleet-pairing.docs.descriptor.js +89 -0
- package/dist/docs/fleet-pairing.docs.descriptor.js.map +1 -0
- package/dist/docs/getting-started-cli.docs.descriptor.d.ts +4 -0
- package/dist/docs/getting-started-cli.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/getting-started-cli.docs.descriptor.js +141 -0
- package/dist/docs/getting-started-cli.docs.descriptor.js.map +1 -0
- package/dist/docs/getting-started.concepts.docs.descriptor.d.ts +4 -0
- package/dist/docs/getting-started.concepts.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/getting-started.concepts.docs.descriptor.js +100 -0
- package/dist/docs/getting-started.concepts.docs.descriptor.js.map +1 -0
- package/dist/docs/getting-started.docs.descriptor.d.ts +4 -0
- package/dist/docs/getting-started.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/getting-started.docs.descriptor.js +63 -0
- package/dist/docs/getting-started.docs.descriptor.js.map +1 -0
- package/dist/docs/getting-started.first-query.docs.descriptor.d.ts +4 -0
- package/dist/docs/getting-started.first-query.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/getting-started.first-query.docs.descriptor.js +95 -0
- package/dist/docs/getting-started.first-query.docs.descriptor.js.map +1 -0
- package/dist/docs/guided-flows.flows.docs.descriptor.d.ts +22 -0
- package/dist/docs/guided-flows.flows.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/guided-flows.flows.docs.descriptor.js +114 -0
- package/dist/docs/guided-flows.flows.docs.descriptor.js.map +1 -0
- package/dist/docs/runtime-rpc-relay.docs.descriptor.d.ts +19 -0
- package/dist/docs/runtime-rpc-relay.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/runtime-rpc-relay.docs.descriptor.js +140 -0
- package/dist/docs/runtime-rpc-relay.docs.descriptor.js.map +1 -0
- package/dist/docs/tutorials.ai-text-generation.docs.descriptor.d.ts +4 -0
- package/dist/docs/tutorials.ai-text-generation.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/tutorials.ai-text-generation.docs.descriptor.js +115 -0
- package/dist/docs/tutorials.ai-text-generation.docs.descriptor.js.map +1 -0
- package/dist/docs/tutorials.build-an-app.docs.descriptor.d.ts +4 -0
- package/dist/docs/tutorials.build-an-app.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/tutorials.build-an-app.docs.descriptor.js +172 -0
- package/dist/docs/tutorials.build-an-app.docs.descriptor.js.map +1 -0
- package/dist/docs/tutorials.crud-collection.docs.descriptor.d.ts +4 -0
- package/dist/docs/tutorials.crud-collection.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/tutorials.crud-collection.docs.descriptor.js +142 -0
- package/dist/docs/tutorials.crud-collection.docs.descriptor.js.map +1 -0
- package/dist/docs/tutorials.docs.descriptor.d.ts +4 -0
- package/dist/docs/tutorials.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/tutorials.docs.descriptor.js +52 -0
- package/dist/docs/tutorials.docs.descriptor.js.map +1 -0
- package/dist/docs/tutorials.runtime-plugin.docs.descriptor.d.ts +4 -0
- package/dist/docs/tutorials.runtime-plugin.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/tutorials.runtime-plugin.docs.descriptor.js +121 -0
- package/dist/docs/tutorials.runtime-plugin.docs.descriptor.js.map +1 -0
- package/dist/docs.plugin.d.ts +12 -0
- package/dist/docs.plugin.d.ts.map +1 -0
- package/dist/docs.plugin.js +118 -0
- package/dist/docs.plugin.js.map +1 -0
- package/dist/documents/documents.cloud.plugin.d.ts +3 -0
- package/dist/documents/documents.cloud.plugin.d.ts.map +1 -0
- package/dist/documents/documents.cloud.plugin.js +26 -0
- package/dist/documents/documents.cloud.plugin.js.map +1 -0
- package/dist/documents/documents.consumer.plugin.d.ts +3 -0
- package/dist/documents/documents.consumer.plugin.d.ts.map +1 -0
- package/dist/documents/documents.consumer.plugin.js +26 -0
- package/dist/documents/documents.consumer.plugin.js.map +1 -0
- package/dist/documents/documents.plugin.d.ts +3 -0
- package/dist/documents/documents.plugin.d.ts.map +1 -0
- package/dist/documents/documents.plugin.js +33 -0
- package/dist/documents/documents.plugin.js.map +1 -0
- package/dist/documents/docx/client.d.ts +56 -0
- package/dist/documents/docx/client.d.ts.map +1 -0
- package/dist/documents/docx/client.js +90 -0
- package/dist/documents/docx/client.js.map +1 -0
- package/dist/documents/docx/extract.d.ts +12 -0
- package/dist/documents/docx/extract.d.ts.map +1 -0
- package/dist/documents/docx/extract.js +62 -0
- package/dist/documents/docx/extract.js.map +1 -0
- package/dist/documents/docx/generator.d.ts +49 -0
- package/dist/documents/docx/generator.d.ts.map +1 -0
- package/dist/documents/docx/generator.js +101 -0
- package/dist/documents/docx/generator.js.map +1 -0
- package/dist/documents/docx/index.d.ts +19 -0
- package/dist/documents/docx/index.d.ts.map +1 -0
- package/dist/documents/docx/index.js +16 -0
- package/dist/documents/docx/index.js.map +1 -0
- package/dist/documents/docx/kinds.d.ts +10 -0
- package/dist/documents/docx/kinds.d.ts.map +1 -0
- package/dist/documents/docx/kinds.js +11 -0
- package/dist/documents/docx/kinds.js.map +1 -0
- package/dist/documents/docx/plugin/docx.plugin.d.ts +9 -0
- package/dist/documents/docx/plugin/docx.plugin.d.ts.map +1 -0
- package/dist/documents/docx/plugin/docx.plugin.js +35 -0
- package/dist/documents/docx/plugin/docx.plugin.js.map +1 -0
- package/dist/documents/docx/schemas/generator.d.ts +10 -0
- package/dist/documents/docx/schemas/generator.d.ts.map +1 -0
- package/dist/documents/docx/schemas/generator.js +2 -0
- package/dist/documents/docx/schemas/generator.js.map +1 -0
- package/dist/documents/docx/schemas/index.d.ts +4 -0
- package/dist/documents/docx/schemas/index.d.ts.map +1 -0
- package/dist/documents/docx/schemas/index.js +2 -0
- package/dist/documents/docx/schemas/index.js.map +1 -0
- package/dist/documents/docx/schemas/runtime.d.ts +68 -0
- package/dist/documents/docx/schemas/runtime.d.ts.map +1 -0
- package/dist/documents/docx/schemas/runtime.js +30 -0
- package/dist/documents/docx/schemas/runtime.js.map +1 -0
- package/dist/documents/docx/schemas/template-registry.d.ts +21 -0
- package/dist/documents/docx/schemas/template-registry.d.ts.map +1 -0
- package/dist/documents/docx/schemas/template-registry.js +2 -0
- package/dist/documents/docx/schemas/template-registry.js.map +1 -0
- package/dist/documents/docx/templates/index.d.ts +3 -0
- package/dist/documents/docx/templates/index.d.ts.map +1 -0
- package/dist/documents/docx/templates/index.js +2 -0
- package/dist/documents/docx/templates/index.js.map +1 -0
- package/dist/documents/docx/templates/loader.d.ts +20 -0
- package/dist/documents/docx/templates/loader.d.ts.map +1 -0
- package/dist/documents/docx/templates/loader.js +36 -0
- package/dist/documents/docx/templates/loader.js.map +1 -0
- package/dist/documents/docx/templates/types.d.ts +2 -0
- package/dist/documents/docx/templates/types.d.ts.map +1 -0
- package/dist/documents/docx/templates/types.js +2 -0
- package/dist/documents/docx/templates/types.js.map +1 -0
- package/dist/documents/index.d.ts +4 -0
- package/dist/documents/index.d.ts.map +1 -0
- package/dist/documents/index.js +4 -0
- package/dist/documents/index.js.map +1 -0
- package/dist/documents/outline/parse-outline.d.ts +132 -0
- package/dist/documents/outline/parse-outline.d.ts.map +1 -0
- package/dist/documents/outline/parse-outline.js +246 -0
- package/dist/documents/outline/parse-outline.js.map +1 -0
- package/dist/documents/plugin.d.ts +3 -0
- package/dist/documents/plugin.d.ts.map +1 -0
- package/dist/documents/plugin.js +13 -0
- package/dist/documents/plugin.js.map +1 -0
- package/dist/documents/presentations/capabilities/index.d.ts +3 -0
- package/dist/documents/presentations/capabilities/index.d.ts.map +1 -0
- package/dist/documents/presentations/capabilities/index.js +3 -0
- package/dist/documents/presentations/capabilities/index.js.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.directory.impl.consumer.worker.d.ts +333 -0
- package/dist/documents/presentations/capabilities/presentations.directory.impl.consumer.worker.d.ts.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.directory.impl.consumer.worker.js +101 -0
- package/dist/documents/presentations/capabilities/presentations.directory.impl.consumer.worker.js.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.directory.kind.d.ts +65 -0
- package/dist/documents/presentations/capabilities/presentations.directory.kind.d.ts.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.directory.kind.js +152 -0
- package/dist/documents/presentations/capabilities/presentations.directory.kind.js.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.surface.kind.d.ts +68 -0
- package/dist/documents/presentations/capabilities/presentations.surface.kind.d.ts.map +1 -0
- package/dist/documents/presentations/capabilities/presentations.surface.kind.js +100 -0
- package/dist/documents/presentations/capabilities/presentations.surface.kind.js.map +1 -0
- package/dist/documents/presentations/client/contracts.d.ts +20 -0
- package/dist/documents/presentations/client/contracts.d.ts.map +1 -0
- package/dist/documents/presentations/client/contracts.js +2 -0
- package/dist/documents/presentations/client/contracts.js.map +1 -0
- package/dist/documents/presentations/client/index.d.ts +5 -0
- package/dist/documents/presentations/client/index.d.ts.map +1 -0
- package/dist/documents/presentations/client/index.js +5 -0
- package/dist/documents/presentations/client/index.js.map +1 -0
- package/dist/documents/presentations/client/presentations.runtime-client.descriptor.d.ts +4 -0
- package/dist/documents/presentations/client/presentations.runtime-client.descriptor.d.ts.map +1 -0
- package/dist/documents/presentations/client/presentations.runtime-client.descriptor.js +13 -0
- package/dist/documents/presentations/client/presentations.runtime-client.descriptor.js.map +1 -0
- package/dist/documents/presentations/client/presentations.runtime-client.impl.d.ts +711 -0
- package/dist/documents/presentations/client/presentations.runtime-client.impl.d.ts.map +1 -0
- package/dist/documents/presentations/client/presentations.runtime-client.impl.js +72 -0
- package/dist/documents/presentations/client/presentations.runtime-client.impl.js.map +1 -0
- package/dist/documents/presentations/docs/presentations.docs.descriptor.d.ts +4 -0
- package/dist/documents/presentations/docs/presentations.docs.descriptor.d.ts.map +1 -0
- package/dist/documents/presentations/docs/presentations.docs.descriptor.js +54 -0
- package/dist/documents/presentations/docs/presentations.docs.descriptor.js.map +1 -0
- package/dist/documents/presentations/index.d.ts +8 -0
- package/dist/documents/presentations/index.d.ts.map +1 -0
- package/dist/documents/presentations/index.js +8 -0
- package/dist/documents/presentations/index.js.map +1 -0
- package/dist/documents/presentations/presentations.consumer.plugin.d.ts +4 -0
- package/dist/documents/presentations/presentations.consumer.plugin.d.ts.map +1 -0
- package/dist/documents/presentations/presentations.consumer.plugin.js +16 -0
- package/dist/documents/presentations/presentations.consumer.plugin.js.map +1 -0
- package/dist/documents/presentations/presentations.plugin.d.ts +3 -0
- package/dist/documents/presentations/presentations.plugin.d.ts.map +1 -0
- package/dist/documents/presentations/presentations.plugin.js +48 -0
- package/dist/documents/presentations/presentations.plugin.js.map +1 -0
- package/dist/documents/presentations/review-read-authority.d.ts +117 -0
- package/dist/documents/presentations/review-read-authority.d.ts.map +1 -0
- package/dist/documents/presentations/review-read-authority.js +74 -0
- package/dist/documents/presentations/review-read-authority.js.map +1 -0
- package/dist/documents/presentations/schemas/index.d.ts +5 -0
- package/dist/documents/presentations/schemas/index.d.ts.map +1 -0
- package/dist/documents/presentations/schemas/index.js +5 -0
- package/dist/documents/presentations/schemas/index.js.map +1 -0
- package/dist/documents/presentations/schemas/owner.d.ts +28 -0
- package/dist/documents/presentations/schemas/owner.d.ts.map +1 -0
- package/dist/documents/presentations/schemas/owner.js +18 -0
- package/dist/documents/presentations/schemas/owner.js.map +1 -0
- package/dist/documents/presentations/schemas/request.d.ts +325 -0
- package/dist/documents/presentations/schemas/request.d.ts.map +1 -0
- package/dist/documents/presentations/schemas/request.js +169 -0
- package/dist/documents/presentations/schemas/request.js.map +1 -0
- package/dist/documents/presentations/schemas/review.d.ts +154 -0
- package/dist/documents/presentations/schemas/review.d.ts.map +1 -0
- package/dist/documents/presentations/schemas/review.js +83 -0
- package/dist/documents/presentations/schemas/review.js.map +1 -0
- package/dist/documents/presentations/schemas/surface.d.ts +315 -0
- package/dist/documents/presentations/schemas/surface.d.ts.map +1 -0
- package/dist/documents/presentations/schemas/surface.js +125 -0
- package/dist/documents/presentations/schemas/surface.js.map +1 -0
- package/dist/documents/presentations/state-machine.d.ts +36 -0
- package/dist/documents/presentations/state-machine.d.ts.map +1 -0
- package/dist/documents/presentations/state-machine.js +158 -0
- package/dist/documents/presentations/state-machine.js.map +1 -0
- package/dist/documents/presentations/storage/index.d.ts +3 -0
- package/dist/documents/presentations/storage/index.d.ts.map +1 -0
- package/dist/documents/presentations/storage/index.js +3 -0
- package/dist/documents/presentations/storage/index.js.map +1 -0
- package/dist/documents/presentations/storage/owner-app.d.ts +12 -0
- package/dist/documents/presentations/storage/owner-app.d.ts.map +1 -0
- package/dist/documents/presentations/storage/owner-app.js +43 -0
- package/dist/documents/presentations/storage/owner-app.js.map +1 -0
- package/dist/documents/presentations/storage/owner-transforms.d.ts +476 -0
- package/dist/documents/presentations/storage/owner-transforms.d.ts.map +1 -0
- package/dist/documents/presentations/storage/owner-transforms.js +77 -0
- package/dist/documents/presentations/storage/owner-transforms.js.map +1 -0
- package/dist/documents/presentations/storage/records.d.ts +227 -0
- package/dist/documents/presentations/storage/records.d.ts.map +1 -0
- package/dist/documents/presentations/storage/records.js +145 -0
- package/dist/documents/presentations/storage/records.js.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.descriptor.d.ts +543 -0
- package/dist/documents/presentations/tools/presentations.tool.descriptor.d.ts.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.descriptor.js +47 -0
- package/dist/documents/presentations/tools/presentations.tool.descriptor.js.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.impl.consumer.d.ts +8 -0
- package/dist/documents/presentations/tools/presentations.tool.impl.consumer.d.ts.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.impl.consumer.js +68 -0
- package/dist/documents/presentations/tools/presentations.tool.impl.consumer.js.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.schemas.d.ts +504 -0
- package/dist/documents/presentations/tools/presentations.tool.schemas.d.ts.map +1 -0
- package/dist/documents/presentations/tools/presentations.tool.schemas.js +76 -0
- package/dist/documents/presentations/tools/presentations.tool.schemas.js.map +1 -0
- package/dist/documents/render/grid.d.ts +96 -0
- package/dist/documents/render/grid.d.ts.map +1 -0
- package/dist/documents/render/grid.js +115 -0
- package/dist/documents/render/grid.js.map +1 -0
- package/dist/documents/render/index.d.ts +2 -0
- package/dist/documents/render/index.d.ts.map +1 -0
- package/dist/documents/render/index.js +2 -0
- package/dist/documents/render/index.js.map +1 -0
- package/dist/documents/render/render.impl.cloud.d.ts +25 -0
- package/dist/documents/render/render.impl.cloud.d.ts.map +1 -0
- package/dist/documents/render/render.impl.cloud.js +245 -0
- package/dist/documents/render/render.impl.cloud.js.map +1 -0
- package/dist/documents/render/render.impl.consumer.d.ts +35 -0
- package/dist/documents/render/render.impl.consumer.d.ts.map +1 -0
- package/dist/documents/render/render.impl.consumer.js +104 -0
- package/dist/documents/render/render.impl.consumer.js.map +1 -0
- package/dist/documents/render/render.interface.d.ts +147 -0
- package/dist/documents/render/render.interface.d.ts.map +1 -0
- package/dist/documents/render/render.interface.js +90 -0
- package/dist/documents/render/render.interface.js.map +1 -0
- package/dist/documents/schemas/ai-service-binding.schema.d.ts +11 -0
- package/dist/documents/schemas/ai-service-binding.schema.d.ts.map +1 -0
- package/dist/documents/schemas/ai-service-binding.schema.js +8 -0
- package/dist/documents/schemas/ai-service-binding.schema.js.map +1 -0
- package/dist/documents/schemas/document-read.schema.d.ts +107 -0
- package/dist/documents/schemas/document-read.schema.d.ts.map +1 -0
- package/dist/documents/schemas/document-read.schema.js +124 -0
- package/dist/documents/schemas/document-read.schema.js.map +1 -0
- package/dist/documents/schemas/document-view.schema.d.ts +74 -0
- package/dist/documents/schemas/document-view.schema.d.ts.map +1 -0
- package/dist/documents/schemas/document-view.schema.js +66 -0
- package/dist/documents/schemas/document-view.schema.js.map +1 -0
- package/dist/documents/schemas/index.d.ts +3 -0
- package/dist/documents/schemas/index.d.ts.map +1 -0
- package/dist/documents/schemas/index.js +3 -0
- package/dist/documents/schemas/index.js.map +1 -0
- package/dist/documents/schemas/page-cache.schema.d.ts +29 -0
- package/dist/documents/schemas/page-cache.schema.d.ts.map +1 -0
- package/dist/documents/schemas/page-cache.schema.js +50 -0
- package/dist/documents/schemas/page-cache.schema.js.map +1 -0
- package/dist/documents/storage/index.d.ts +3 -0
- package/dist/documents/storage/index.d.ts.map +1 -0
- package/dist/documents/storage/index.js +2 -0
- package/dist/documents/storage/index.js.map +1 -0
- package/dist/documents/storage/page-cache.descriptor.d.ts +17 -0
- package/dist/documents/storage/page-cache.descriptor.d.ts.map +1 -0
- package/dist/documents/storage/page-cache.descriptor.js +45 -0
- package/dist/documents/storage/page-cache.descriptor.js.map +1 -0
- package/dist/documents/tools/descriptors.d.ts +248 -0
- package/dist/documents/tools/descriptors.d.ts.map +1 -0
- package/dist/documents/tools/descriptors.js +78 -0
- package/dist/documents/tools/descriptors.js.map +1 -0
- package/dist/documents/tools/document-read-loop-guard.d.ts +61 -0
- package/dist/documents/tools/document-read-loop-guard.d.ts.map +1 -0
- package/dist/documents/tools/document-read-loop-guard.js +314 -0
- package/dist/documents/tools/document-read-loop-guard.js.map +1 -0
- package/dist/documents/tools/document-read.impl.d.ts +77 -0
- package/dist/documents/tools/document-read.impl.d.ts.map +1 -0
- package/dist/documents/tools/document-read.impl.js +1139 -0
- package/dist/documents/tools/document-read.impl.js.map +1 -0
- package/dist/documents/tools/document-view.impl.d.ts +45 -0
- package/dist/documents/tools/document-view.impl.d.ts.map +1 -0
- package/dist/documents/tools/document-view.impl.js +168 -0
- package/dist/documents/tools/document-view.impl.js.map +1 -0
- package/dist/documents/tools/index.d.ts +3 -0
- package/dist/documents/tools/index.d.ts.map +1 -0
- package/dist/documents/tools/index.js +6 -0
- package/dist/documents/tools/index.js.map +1 -0
- package/dist/documents/tools/source-refresh.d.ts +33 -0
- package/dist/documents/tools/source-refresh.d.ts.map +1 -0
- package/dist/documents/tools/source-refresh.js +127 -0
- package/dist/documents/tools/source-refresh.js.map +1 -0
- package/dist/documents/tools/unavailable.impl.d.ts +5 -0
- package/dist/documents/tools/unavailable.impl.d.ts.map +1 -0
- package/dist/documents/tools/unavailable.impl.js +12 -0
- package/dist/documents/tools/unavailable.impl.js.map +1 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts/descriptors/vibes-platform.prompt.descriptor.d.ts +113 -0
- package/dist/prompts/descriptors/vibes-platform.prompt.descriptor.d.ts.map +1 -0
- package/dist/prompts/descriptors/vibes-platform.prompt.descriptor.js +35 -0
- package/dist/prompts/descriptors/vibes-platform.prompt.descriptor.js.map +1 -0
- package/dist/render/ansi.d.ts +86 -0
- package/dist/render/ansi.d.ts.map +1 -0
- package/dist/render/ansi.js +125 -0
- package/dist/render/ansi.js.map +1 -0
- package/dist/render/frontmatter.d.ts +21 -0
- package/dist/render/frontmatter.d.ts.map +1 -0
- package/dist/render/frontmatter.js +57 -0
- package/dist/render/frontmatter.js.map +1 -0
- package/dist/render/index.d.ts +10 -0
- package/dist/render/index.d.ts.map +1 -0
- package/dist/render/index.js +6 -0
- package/dist/render/index.js.map +1 -0
- package/dist/render/parse.d.ts +29 -0
- package/dist/render/parse.d.ts.map +1 -0
- package/dist/render/parse.js +145 -0
- package/dist/render/parse.js.map +1 -0
- package/dist/render/sections.d.ts +24 -0
- package/dist/render/sections.d.ts.map +1 -0
- package/dist/render/sections.js +76 -0
- package/dist/render/sections.js.map +1 -0
- package/dist/render/terminal.d.ts +15 -0
- package/dist/render/terminal.d.ts.map +1 -0
- package/dist/render/terminal.js +293 -0
- package/dist/render/terminal.js.map +1 -0
- package/dist/runbooks/index.d.ts +4 -0
- package/dist/runbooks/index.d.ts.map +1 -0
- package/dist/runbooks/index.js +3 -0
- package/dist/runbooks/index.js.map +1 -0
- package/dist/runbooks/runbooks.plugin.d.ts +3 -0
- package/dist/runbooks/runbooks.plugin.d.ts.map +1 -0
- package/dist/runbooks/runbooks.plugin.js +3 -0
- package/dist/runbooks/runbooks.plugin.js.map +1 -0
- package/dist/schemas/citations.schema.d.ts +21 -0
- package/dist/schemas/citations.schema.d.ts.map +1 -0
- package/dist/schemas/citations.schema.js +17 -0
- package/dist/schemas/citations.schema.js.map +1 -0
- package/dist/schemas/index.d.ts +4 -0
- package/dist/schemas/index.d.ts.map +1 -0
- package/dist/schemas/index.js +3 -0
- package/dist/schemas/index.js.map +1 -0
- package/dist/schemas/topic.schema.d.ts +179 -0
- package/dist/schemas/topic.schema.d.ts.map +1 -0
- package/dist/schemas/topic.schema.js +15 -0
- package/dist/schemas/topic.schema.js.map +1 -0
- package/dist/svelte/build/highlight.d.ts +33 -0
- package/dist/svelte/build/highlight.d.ts.map +1 -0
- package/dist/svelte/build/highlight.js +95 -0
- package/dist/svelte/build/topic-index.d.ts +96 -0
- package/dist/svelte/build/topic-index.d.ts.map +1 -0
- package/dist/svelte/build/topic-index.js +247 -0
- package/dist/svelte/context.d.ts +12 -0
- package/dist/svelte/context.d.ts.map +1 -0
- package/dist/svelte/context.js +16 -0
- package/dist/svelte/docs-origin.d.ts +14 -0
- package/dist/svelte/docs-origin.d.ts.map +1 -0
- package/dist/svelte/docs-origin.js +49 -0
- package/dist/svelte/docs-svelte.plugin.d.ts +121 -0
- package/dist/svelte/docs-svelte.plugin.d.ts.map +1 -0
- package/dist/svelte/docs-svelte.plugin.js +35 -0
- package/dist/svelte/documents/presentations/components/PresentationMonitor.svelte +261 -0
- package/dist/svelte/documents/presentations/components/PresentationMonitor.svelte.d.ts +16 -0
- package/dist/svelte/documents/presentations/components/PresentationMonitor.svelte.d.ts.map +1 -0
- package/dist/svelte/documents/presentations/index.d.ts +3 -0
- package/dist/svelte/documents/presentations/index.d.ts.map +1 -0
- package/dist/svelte/documents/presentations/index.js +2 -0
- package/dist/svelte/documents/presentations/monitor-state.d.ts +17 -0
- package/dist/svelte/documents/presentations/monitor-state.d.ts.map +1 -0
- package/dist/svelte/documents/presentations/monitor-state.js +38 -0
- package/dist/svelte/index.d.ts +20 -0
- package/dist/svelte/index.d.ts.map +1 -0
- package/dist/svelte/index.js +16 -0
- package/dist/svelte/loaders.d.ts +57 -0
- package/dist/svelte/loaders.d.ts.map +1 -0
- package/dist/svelte/loaders.js +74 -0
- package/dist/svelte/state.svelte.d.ts +366 -0
- package/dist/svelte/state.svelte.d.ts.map +1 -0
- package/dist/svelte/state.svelte.js +155 -0
- package/dist/svelte/styles.css +8 -0
- package/dist/svelte/tool-widgets/DocsToolCard.svelte +41 -0
- package/dist/svelte/tool-widgets/DocsToolCard.svelte.d.ts +5 -0
- package/dist/svelte/tool-widgets/DocsToolCard.svelte.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/DocumentReadToolCard.svelte +28 -0
- package/dist/svelte/tool-widgets/DocumentReadToolCard.svelte.d.ts +8 -0
- package/dist/svelte/tool-widgets/DocumentReadToolCard.svelte.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/PresentationsToolCard.svelte +25 -0
- package/dist/svelte/tool-widgets/PresentationsToolCard.svelte.d.ts +8 -0
- package/dist/svelte/tool-widgets/PresentationsToolCard.svelte.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/RunbookToolCard.svelte +29 -0
- package/dist/svelte/tool-widgets/RunbookToolCard.svelte.d.ts +8 -0
- package/dist/svelte/tool-widgets/RunbookToolCard.svelte.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/index.d.ts +7 -0
- package/dist/svelte/tool-widgets/index.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/index.js +5 -0
- package/dist/svelte/tool-widgets/models.d.ts +47 -0
- package/dist/svelte/tool-widgets/models.d.ts.map +1 -0
- package/dist/svelte/tool-widgets/models.js +112 -0
- package/dist/svelte/ui/DocViewer.svelte +122 -0
- package/dist/svelte/ui/DocViewer.svelte.d.ts +17 -0
- package/dist/svelte/ui/DocViewer.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/DocsLoader.svelte +37 -0
- package/dist/svelte/ui/DocsLoader.svelte.d.ts +21 -0
- package/dist/svelte/ui/DocsLoader.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/DocsSearch.svelte +129 -0
- package/dist/svelte/ui/DocsSearch.svelte.d.ts +15 -0
- package/dist/svelte/ui/DocsSearch.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Card.svelte +61 -0
- package/dist/svelte/ui/directives/Card.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Card.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Descriptor.svelte +73 -0
- package/dist/svelte/ui/directives/Descriptor.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Descriptor.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/DirectiveDispatch.svelte +45 -0
- package/dist/svelte/ui/directives/DirectiveDispatch.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/DirectiveDispatch.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Endpoint.svelte +68 -0
- package/dist/svelte/ui/directives/Endpoint.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Endpoint.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Install.svelte +112 -0
- package/dist/svelte/ui/directives/Install.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Install.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Shell.svelte +32 -0
- package/dist/svelte/ui/directives/Shell.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Shell.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/directives/Usage.svelte +14 -0
- package/dist/svelte/ui/directives/Usage.svelte.d.ts +8 -0
- package/dist/svelte/ui/directives/Usage.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/help/HelpDialog.svelte +210 -0
- package/dist/svelte/ui/help/HelpDialog.svelte.d.ts +11 -0
- package/dist/svelte/ui/help/HelpDialog.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/help/HelpIcon.svelte +83 -0
- package/dist/svelte/ui/help/HelpIcon.svelte.d.ts +16 -0
- package/dist/svelte/ui/help/HelpIcon.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/markdown/CodeBlock.svelte +125 -0
- package/dist/svelte/ui/markdown/CodeBlock.svelte.d.ts +8 -0
- package/dist/svelte/ui/markdown/CodeBlock.svelte.d.ts.map +1 -0
- package/dist/svelte/ui/markdown/MarkdownView.svelte +319 -0
- package/dist/svelte/ui/markdown/MarkdownView.svelte.d.ts +9 -0
- package/dist/svelte/ui/markdown/MarkdownView.svelte.d.ts.map +1 -0
- package/dist/tools/docs.descriptor.d.ts +48 -0
- package/dist/tools/docs.descriptor.d.ts.map +1 -0
- package/dist/tools/docs.descriptor.js +23 -0
- package/dist/tools/docs.descriptor.js.map +1 -0
- package/dist/tools/docs.impl.d.ts +7 -0
- package/dist/tools/docs.impl.d.ts.map +1 -0
- package/dist/tools/docs.impl.js +67 -0
- package/dist/tools/docs.impl.js.map +1 -0
- package/dist/tools/schemas.d.ts +43 -0
- package/dist/tools/schemas.d.ts.map +1 -0
- package/dist/tools/schemas.js +30 -0
- package/dist/tools/schemas.js.map +1 -0
- package/dist/tui/docs-tui.plugin.d.ts +3 -0
- package/dist/tui/docs-tui.plugin.d.ts.map +1 -0
- package/dist/tui/docs-tui.plugin.js +18 -0
- package/dist/tui/docs-tui.plugin.js.map +1 -0
- package/dist/tui/index.d.ts +2 -0
- package/dist/tui/index.d.ts.map +1 -0
- package/dist/tui/index.js +2 -0
- package/dist/tui/index.js.map +1 -0
- package/dist/tui/tui/docs-explorer.impl.consumer.d.ts +38 -0
- package/dist/tui/tui/docs-explorer.impl.consumer.d.ts.map +1 -0
- package/dist/tui/tui/docs-explorer.impl.consumer.js +334 -0
- package/dist/tui/tui/docs-explorer.impl.consumer.js.map +1 -0
- package/dist/tui/tui/docs-explorer.tui.descriptor.d.ts +13 -0
- package/dist/tui/tui/docs-explorer.tui.descriptor.d.ts.map +1 -0
- package/dist/tui/tui/docs-explorer.tui.descriptor.js +29 -0
- package/dist/tui/tui/docs-explorer.tui.descriptor.js.map +1 -0
- package/package.json +450 -4
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for charts.usage
|
|
3
|
+
*
|
|
4
|
+
* Charts is a surface-only feature (no base @vibesdotdev/charts plugin in the
|
|
5
|
+
* standard umbrella); the components live in @vibesdotdev/kit/components/viz.
|
|
6
|
+
* This descriptor is registered through the docs plugin so the topic is
|
|
7
|
+
* discoverable from `vibes docs list`.
|
|
8
|
+
*/
|
|
9
|
+
const chartsUsageMarkdown = `---
|
|
10
|
+
title: Charts Usage
|
|
11
|
+
summary: Dependency-free SVG chart primitives for Svelte — sparklines, usage bars, trend cards
|
|
12
|
+
tags: [charts, svelte, ui, visualization, sparkline]
|
|
13
|
+
parent: charts
|
|
14
|
+
order: 1
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Charts Usage
|
|
18
|
+
|
|
19
|
+
\`@vibesdotdev/kit/components/viz\` provides a tiny set of dependency-free SVG chart primitives mounted on app dashboards: sparklines, usage bars, trend cards, and a minimal multi-series chart. No external charting library is required — components render directly into SVG with sensible defaults.
|
|
20
|
+
|
|
21
|
+
## What this provides
|
|
22
|
+
|
|
23
|
+
- **\`<Sparkline>\`** — inline mini-line chart for trend visualization in a small footprint.
|
|
24
|
+
- **\`<UsageBar>\`** — horizontal usage/quota bar with label, value, and limit.
|
|
25
|
+
- **\`<TrendCard>\`** — a sparkline + numeric delta in a card layout for dashboard tiles.
|
|
26
|
+
- **\`<MultiSeriesChart>\`** — minimal multi-series line/area chart with axis labels.
|
|
27
|
+
|
|
28
|
+
## Types and clients
|
|
29
|
+
|
|
30
|
+
\`\`\`ts
|
|
31
|
+
import {
|
|
32
|
+
Sparkline,
|
|
33
|
+
UsageBar,
|
|
34
|
+
TrendCard,
|
|
35
|
+
MultiSeriesChart
|
|
36
|
+
} from '@vibesdotdev/kit/components/viz';
|
|
37
|
+
\`\`\`
|
|
38
|
+
|
|
39
|
+
## Usage examples
|
|
40
|
+
|
|
41
|
+
\`\`\`svelte
|
|
42
|
+
<script lang="ts">
|
|
43
|
+
import { Sparkline, UsageBar, TrendCard } from '@vibesdotdev/kit/components/viz';
|
|
44
|
+
|
|
45
|
+
const requests = [12, 18, 15, 22, 30, 28, 34];
|
|
46
|
+
</script>
|
|
47
|
+
|
|
48
|
+
<Sparkline data={requests} width={120} height={32} />
|
|
49
|
+
|
|
50
|
+
<UsageBar
|
|
51
|
+
label="API requests"
|
|
52
|
+
value={3210}
|
|
53
|
+
max={5000}
|
|
54
|
+
/>
|
|
55
|
+
|
|
56
|
+
<TrendCard
|
|
57
|
+
label="Last 7 days"
|
|
58
|
+
value={3210}
|
|
59
|
+
delta={+12.4}
|
|
60
|
+
data={requests}
|
|
61
|
+
/>
|
|
62
|
+
\`\`\`
|
|
63
|
+
|
|
64
|
+
## Commands available
|
|
65
|
+
|
|
66
|
+
Charts is a UI-only surface — there are no CLI commands. Charts components mount on app dashboards (e.g. \`apps/account-web\`, \`apps/system-web\`) and consume data from app-specific server endpoints.
|
|
67
|
+
|
|
68
|
+
## Related topics
|
|
69
|
+
|
|
70
|
+
- (no related topics in the base catalog yet)
|
|
71
|
+
`;
|
|
72
|
+
const descriptor = {
|
|
73
|
+
kind: 'docs/topic',
|
|
74
|
+
id: 'charts.usage',
|
|
75
|
+
title: 'Charts Usage',
|
|
76
|
+
summary: 'Dependency-free SVG chart primitives for Svelte — sparklines, usage bars, trend cards',
|
|
77
|
+
body: {
|
|
78
|
+
type: 'markdown',
|
|
79
|
+
sourceType: 'raw',
|
|
80
|
+
source: chartsUsageMarkdown
|
|
81
|
+
},
|
|
82
|
+
parent: 'charts',
|
|
83
|
+
order: 1,
|
|
84
|
+
tags: ['charts', 'svelte', 'ui', 'visualization', 'sparkline'],
|
|
85
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
86
|
+
hardware: ['consumer'],
|
|
87
|
+
enabled: true
|
|
88
|
+
};
|
|
89
|
+
export default descriptor;
|
|
90
|
+
//# sourceMappingURL=charts.usage.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"charts.usage.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/charts.usage.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8D3B,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,YAAqB;IAC3B,EAAE,EAAE,cAAc;IAClB,KAAK,EAAE,cAAc;IACrB,OAAO,EAAE,uFAAuF;IAChG,IAAI,EAAE;QACJ,IAAI,EAAE,UAAmB;QACzB,UAAU,EAAE,KAAc;QAC1B,MAAM,EAAE,mBAAmB;KAC5B;IACD,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,WAAW,CAAC;IAC9D,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU;IAC3C,QAAQ,EAAE,CAAC,UAAU,CAAU;IAC/B,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for command-palette.actions
|
|
3
|
+
*
|
|
4
|
+
* Command-palette is a surface-only feature; this docs topic lives in the
|
|
5
|
+
* docs package so it's reachable via the standard docs umbrella.
|
|
6
|
+
*/
|
|
7
|
+
declare const descriptor: {
|
|
8
|
+
kind: "docs/topic";
|
|
9
|
+
id: string;
|
|
10
|
+
title: string;
|
|
11
|
+
summary: string;
|
|
12
|
+
body: {
|
|
13
|
+
type: "markdown";
|
|
14
|
+
sourceType: "raw";
|
|
15
|
+
source: string;
|
|
16
|
+
};
|
|
17
|
+
parent: string;
|
|
18
|
+
order: number;
|
|
19
|
+
tags: string[];
|
|
20
|
+
surfaces: readonly ["cli", "web", "in-app"];
|
|
21
|
+
hardware: readonly ["consumer"];
|
|
22
|
+
enabled: boolean;
|
|
23
|
+
};
|
|
24
|
+
export default descriptor;
|
|
25
|
+
//# sourceMappingURL=command-palette.actions.docs.descriptor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"command-palette.actions.docs.descriptor.d.ts","sourceRoot":"","sources":["../../src/docs/command-palette.actions.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA0DH,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;CAgBf,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for command-palette.actions
|
|
3
|
+
*
|
|
4
|
+
* Command-palette is a surface-only feature; this docs topic lives in the
|
|
5
|
+
* docs package so it's reachable via the standard docs umbrella.
|
|
6
|
+
*/
|
|
7
|
+
const commandPaletteActionsMarkdown = `---
|
|
8
|
+
title: Command Palette Actions
|
|
9
|
+
summary: Federated search + actions surface — sources, results, and renderers across web, TUI, CLI, and bridge
|
|
10
|
+
tags: [command-palette, actions, search, federator, palette]
|
|
11
|
+
parent: command-palette
|
|
12
|
+
order: 1
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Command Palette Actions
|
|
16
|
+
|
|
17
|
+
The command palette is a federated search-and-act surface that aggregates results from multiple **sources** (app navigation, recent items, knowledge, pages, actions) and renders them through pluggable renderers. It runs on web, TUI, CLI, and bridge surfaces.
|
|
18
|
+
|
|
19
|
+
## What this provides
|
|
20
|
+
|
|
21
|
+
- **\`command-palette/source\` kind** — pluggable result sources (app-navigation, recent-items, actions, knowledge, pages).
|
|
22
|
+
- **\`command-palette/surface\` kind** — per-surface configuration (web, tui, cli, bridge).
|
|
23
|
+
- **Federator** — merges and ranks results from registered sources.
|
|
24
|
+
- **Renderers** — default and navigation-specific result rendering primitives.
|
|
25
|
+
- **\`<AppCommandPalette>\`** — Svelte component mounted in the app shell.
|
|
26
|
+
|
|
27
|
+
## Types and clients
|
|
28
|
+
|
|
29
|
+
\`\`\`ts
|
|
30
|
+
import { CommandPaletteClient } from '@vibesdotdev/command-palette';
|
|
31
|
+
import type {
|
|
32
|
+
CommandPaletteResult,
|
|
33
|
+
PageDef,
|
|
34
|
+
RegisteredAction
|
|
35
|
+
} from '@vibesdotdev/command-palette/schemas';
|
|
36
|
+
\`\`\`
|
|
37
|
+
|
|
38
|
+
## Built-in sources
|
|
39
|
+
|
|
40
|
+
| Source | Purpose | Priority |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| \`app-navigation\` | Search across all registered apps | 100 |
|
|
43
|
+
| \`recent-items\` | Recently visited entries from session history | 90 |
|
|
44
|
+
| \`actions\` | Registered \`RegisteredAction\` entries (run, navigate, modal) | 80 |
|
|
45
|
+
| \`knowledge\` | Knowledge-base search | 70 |
|
|
46
|
+
| \`pages\` | App pages and routes | 60 |
|
|
47
|
+
|
|
48
|
+
## Commands available
|
|
49
|
+
|
|
50
|
+
Command palette is invoked via keyboard shortcut (e.g. \`Cmd+K\`) inside an app surface — there are no dedicated CLI commands. The palette client is consumed programmatically:
|
|
51
|
+
|
|
52
|
+
\`\`\`ts
|
|
53
|
+
const palette = new CommandPaletteClient();
|
|
54
|
+
const results = await palette.search('settings');
|
|
55
|
+
\`\`\`
|
|
56
|
+
|
|
57
|
+
## Related topics
|
|
58
|
+
|
|
59
|
+
- [\`knowledge.search\`](knowledge.search) — knowledge source backing palette search
|
|
60
|
+
- (other action-surface integrations as they land)
|
|
61
|
+
`;
|
|
62
|
+
const descriptor = {
|
|
63
|
+
kind: 'docs/topic',
|
|
64
|
+
id: 'command-palette.actions',
|
|
65
|
+
title: 'Command Palette Actions',
|
|
66
|
+
summary: 'Federated search + actions surface — sources, results, and renderers across web, TUI, CLI, and bridge',
|
|
67
|
+
body: {
|
|
68
|
+
type: 'markdown',
|
|
69
|
+
sourceType: 'raw',
|
|
70
|
+
source: commandPaletteActionsMarkdown
|
|
71
|
+
},
|
|
72
|
+
parent: 'command-palette',
|
|
73
|
+
order: 1,
|
|
74
|
+
tags: ['command-palette', 'actions', 'search', 'federator', 'palette'],
|
|
75
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
76
|
+
hardware: ['consumer'],
|
|
77
|
+
enabled: true
|
|
78
|
+
};
|
|
79
|
+
export default descriptor;
|
|
80
|
+
//# sourceMappingURL=command-palette.actions.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"command-palette.actions.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/command-palette.actions.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,6BAA6B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsDrC,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,YAAqB;IAC3B,EAAE,EAAE,yBAAyB;IAC7B,KAAK,EAAE,yBAAyB;IAChC,OAAO,EAAE,uGAAuG;IAChH,IAAI,EAAE;QACJ,IAAI,EAAE,UAAmB;QACzB,UAAU,EAAE,KAAc;QAC1B,MAAM,EAAE,6BAA6B;KACtC;IACD,MAAM,EAAE,iBAAiB;IACzB,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC,iBAAiB,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,CAAC;IACtE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU;IAC3C,QAAQ,EAAE,CAAC,UAAU,CAAU;IAC/B,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for docs.directives
|
|
3
|
+
*/
|
|
4
|
+
declare const descriptor: {
|
|
5
|
+
kind: "docs/topic";
|
|
6
|
+
id: string;
|
|
7
|
+
title: string;
|
|
8
|
+
summary: string;
|
|
9
|
+
body: {
|
|
10
|
+
type: "markdown";
|
|
11
|
+
sourceType: "raw";
|
|
12
|
+
source: string;
|
|
13
|
+
};
|
|
14
|
+
parent: string;
|
|
15
|
+
order: number;
|
|
16
|
+
tags: string[];
|
|
17
|
+
surfaces: readonly ["cli", "web", "in-app"];
|
|
18
|
+
hardware: readonly ["consumer"];
|
|
19
|
+
enabled: boolean;
|
|
20
|
+
};
|
|
21
|
+
export default descriptor;
|
|
22
|
+
//# sourceMappingURL=docs.directives.docs.descriptor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs.directives.docs.descriptor.d.ts","sourceRoot":"","sources":["../../src/docs/docs.directives.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAqFH,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;CAgBf,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for docs.directives
|
|
3
|
+
*/
|
|
4
|
+
const docsDirectivesMarkdown = `---
|
|
5
|
+
title: Docs Directives
|
|
6
|
+
summary: Markdown directives like :::card, :::usage, :::endpoint that render as structured components
|
|
7
|
+
tags: [docs, directives, markdown, components]
|
|
8
|
+
parent: docs
|
|
9
|
+
order: 2
|
|
10
|
+
id: docs.directives
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Docs Directives
|
|
14
|
+
|
|
15
|
+
The docs renderer understands a small set of **directive blocks** — fenced \`:::name{attrs}\` regions that render as structured UI components on web and degrade gracefully to plain text when a topic body is formatted for the terminal.
|
|
16
|
+
|
|
17
|
+
## What this provides
|
|
18
|
+
|
|
19
|
+
- **Directive registry** — \`@vibesdotdev/docs/directives\` exports the six builtin directive descriptors plus \`builtinDirectives\` and \`indexDirectives()\`.
|
|
20
|
+
- **Parser** — \`@vibesdotdev/docs/render\` exposes \`parseMarkdown()\`, which lexes a topic body (frontmatter + tokens); \`tokenToDirectiveNode()\` maps a directive token onto the \`DirectiveNode\` shape consumed by renderers.
|
|
21
|
+
- **Renderers** — CLI rendering lives in \`@vibesdotdev/docs/directives\` (\`renderDirectiveCli(node, ansi)\`); web rendering lives in \`@vibesdotdev/docs/svelte\` (\`DirectiveDispatch.svelte\`, surfaced through \`MarkdownView\`).
|
|
22
|
+
|
|
23
|
+
## Built-in directives
|
|
24
|
+
|
|
25
|
+
Exactly six directives are registered in \`builtinDirectives\`. There are no other directive names.
|
|
26
|
+
|
|
27
|
+
| Directive | Attributes | Body? | Purpose |
|
|
28
|
+
|---|---|---|---|
|
|
29
|
+
| \`:::card{title="..."}\` | \`title?\` | yes | Titled bordered card around the body content |
|
|
30
|
+
| \`:::usage{language=ts}\` | \`language\` (default \`ts\`) | yes | Code-usage example block |
|
|
31
|
+
| \`:::shell{...}\` | free-form \`key=val\` | yes | Shell command block with a copy affordance |
|
|
32
|
+
| \`:::install{package="..."}\` | \`package\` | yes | Install card with copy-able shell commands |
|
|
33
|
+
| \`:::endpoint{method=GET path=/api/...}\` | \`method\`, \`path\`, \`appId?\` | no | One-line HTTP endpoint card |
|
|
34
|
+
| \`:::descriptor{kind=... id=...}\` | \`kind\`, \`id\` | no | Kit-styled reference card for a runtime descriptor |
|
|
35
|
+
|
|
36
|
+
\`method\` accepts \`GET\`, \`POST\`, \`PUT\`, \`PATCH\`, or \`DELETE\`.
|
|
37
|
+
|
|
38
|
+
## Authoring examples
|
|
39
|
+
|
|
40
|
+
:::usage{language=md}
|
|
41
|
+
:::card{title="See also"}
|
|
42
|
+
A bordered callout. Markdown inside the body renders normally.
|
|
43
|
+
:::
|
|
44
|
+
|
|
45
|
+
:::usage{language=ts}
|
|
46
|
+
import { parseMarkdown, tokenToDirectiveNode } from '@vibesdotdev/docs/render';
|
|
47
|
+
:::
|
|
48
|
+
|
|
49
|
+
:::endpoint{method=GET path=/api/docs/topics}
|
|
50
|
+
|
|
51
|
+
:::descriptor{kind=docs/topic id=docs.directives}
|
|
52
|
+
:::
|
|
53
|
+
|
|
54
|
+
## Parsing and rendering
|
|
55
|
+
|
|
56
|
+
\`\`\`ts
|
|
57
|
+
import { renderDirectiveCli, builtinDirectives, indexDirectives } from '@vibesdotdev/docs/directives';
|
|
58
|
+
import { parseMarkdown, tokenToDirectiveNode, createAnsi, readAnsiEnv } from '@vibesdotdev/docs/render';
|
|
59
|
+
|
|
60
|
+
import { writeStdoutLine } from '@vibesdotdev/cli/output';
|
|
61
|
+
|
|
62
|
+
const ansi = createAnsi(readAnsiEnv(runtime)); // the handed runtime's no-color env
|
|
63
|
+
const { tokens } = parseMarkdown(topicBody);
|
|
64
|
+
for (const token of tokens) {
|
|
65
|
+
const node = tokenToDirectiveNode(token);
|
|
66
|
+
if (node) {
|
|
67
|
+
// CLI: degrade to plain text; web uses DirectiveDispatch.svelte instead
|
|
68
|
+
await writeStdoutLine(runtime, renderDirectiveCli(node, ansi));
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
\`\`\`
|
|
72
|
+
|
|
73
|
+
The directive descriptors themselves are available for validation or tooling:
|
|
74
|
+
|
|
75
|
+
\`\`\`ts
|
|
76
|
+
|
|
77
|
+
const byName = indexDirectives(builtinDirectives);
|
|
78
|
+
const card = byName.get('card'); // { name, attrs (zod), hasBody, description }
|
|
79
|
+
\`\`\`
|
|
80
|
+
|
|
81
|
+
## Related topics
|
|
82
|
+
|
|
83
|
+
- [docs.topics](docs.topics) — descriptor shape and body types
|
|
84
|
+
- [docs.cli](docs.cli) — the \`vibes docs\` surface
|
|
85
|
+
`;
|
|
86
|
+
const descriptor = {
|
|
87
|
+
kind: 'docs/topic',
|
|
88
|
+
id: 'docs.directives',
|
|
89
|
+
title: 'Docs Directives',
|
|
90
|
+
summary: 'Markdown directives like :::card, :::usage, :::endpoint that render as structured components',
|
|
91
|
+
body: {
|
|
92
|
+
type: 'markdown',
|
|
93
|
+
sourceType: 'raw',
|
|
94
|
+
source: docsDirectivesMarkdown
|
|
95
|
+
},
|
|
96
|
+
parent: 'docs',
|
|
97
|
+
order: 2,
|
|
98
|
+
tags: ['docs', 'directives', 'markdown', 'components'],
|
|
99
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
100
|
+
hardware: ['consumer'],
|
|
101
|
+
enabled: true
|
|
102
|
+
};
|
|
103
|
+
export default descriptor;
|
|
104
|
+
//# sourceMappingURL=docs.directives.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs.directives.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/docs.directives.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiF9B,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,YAAqB;IAC3B,EAAE,EAAE,iBAAiB;IACrB,KAAK,EAAE,iBAAiB;IACxB,OAAO,EAAE,8FAA8F;IACvG,IAAI,EAAE;QACJ,IAAI,EAAE,UAAmB;QACzB,UAAU,EAAE,KAAc;QAC1B,MAAM,EAAE,sBAAsB;KAC/B;IACD,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,CAAC;IACtD,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU;IAC3C,QAAQ,EAAE,CAAC,UAAU,CAAU;IAC/B,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for docs.topics
|
|
3
|
+
*/
|
|
4
|
+
declare const descriptor: {
|
|
5
|
+
kind: "docs/topic";
|
|
6
|
+
id: string;
|
|
7
|
+
title: string;
|
|
8
|
+
summary: string;
|
|
9
|
+
body: {
|
|
10
|
+
type: "markdown";
|
|
11
|
+
sourceType: "raw";
|
|
12
|
+
source: string;
|
|
13
|
+
};
|
|
14
|
+
parent: string;
|
|
15
|
+
order: number;
|
|
16
|
+
tags: string[];
|
|
17
|
+
surfaces: readonly ["cli", "web", "in-app"];
|
|
18
|
+
hardware: readonly ["consumer"];
|
|
19
|
+
enabled: boolean;
|
|
20
|
+
};
|
|
21
|
+
export default descriptor;
|
|
22
|
+
//# sourceMappingURL=docs.topics.docs.descriptor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs.topics.docs.descriptor.d.ts","sourceRoot":"","sources":["../../src/docs/docs.topics.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAuEH,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;CAgBf,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Descriptor for docs.topics
|
|
3
|
+
*/
|
|
4
|
+
const docsTopicsMarkdown = `---
|
|
5
|
+
title: Docs Topics
|
|
6
|
+
summary: The docs/topic runtime kind — discoverable, addressable units of user-facing documentation
|
|
7
|
+
tags: [docs, topics, descriptors, runtime]
|
|
8
|
+
parent: docs
|
|
9
|
+
order: 1
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Docs Topics
|
|
13
|
+
|
|
14
|
+
A **docs/topic** is a runtime descriptor that defines a single, addressable unit of user-facing documentation. Topics are discovered via the runtime registry, rendered by the docs client, and surfaced in CLI (\`vibes docs list\`), web (\`/docs\`), in-app help, and MCP prompts.
|
|
15
|
+
|
|
16
|
+
## What this provides
|
|
17
|
+
|
|
18
|
+
- **\`docs/topic\` runtime kind** — registered by \`@vibesdotdev/docs\`, validated against \`DocsTopicDescriptorSchema\` from \`@vibesdotdev/docs-contracts\`.
|
|
19
|
+
- **Hardware-aware resolution** — when multiple topics share an id, the runtime picks the candidate whose \`hardware\` field matches the active scope (defaults to consumer).
|
|
20
|
+
- **Surface filtering** — topics declare which surfaces (\`cli\`, \`web\`, \`in-app\`, \`mcp\`) they should appear on.
|
|
21
|
+
- **Body types** — topics carry their content as inline markdown, package-source markdown, components, OpenAPI/GraphQL refs, route paths, or descriptor refs.
|
|
22
|
+
|
|
23
|
+
## Types and clients
|
|
24
|
+
|
|
25
|
+
\`\`\`ts
|
|
26
|
+
import { DocsTopicDescriptorSchema, type DocsTopicDescriptor } from '@vibesdotdev/docs-contracts';
|
|
27
|
+
import { getVibesDocsClient } from '@vibesdotdev/docs';
|
|
28
|
+
|
|
29
|
+
const docs = await getVibesDocsClient(runtime);
|
|
30
|
+
const topics = docs.list();
|
|
31
|
+
\`\`\`
|
|
32
|
+
|
|
33
|
+
## Descriptor shape
|
|
34
|
+
|
|
35
|
+
\`\`\`ts
|
|
36
|
+
const myTopic: DocsTopicDescriptor = {
|
|
37
|
+
kind: 'docs/topic',
|
|
38
|
+
id: 'feature.subtopic',
|
|
39
|
+
title: 'Feature Subtopic',
|
|
40
|
+
summary: 'One-line summary that shows in lists and search results',
|
|
41
|
+
body: { type: 'markdown', sourceType: 'raw', source: '# ...' },
|
|
42
|
+
parent: 'feature',
|
|
43
|
+
order: 1,
|
|
44
|
+
tags: ['feature'],
|
|
45
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
46
|
+
hardware: ['consumer'],
|
|
47
|
+
enabled: true
|
|
48
|
+
};
|
|
49
|
+
\`\`\`
|
|
50
|
+
|
|
51
|
+
## Commands available
|
|
52
|
+
|
|
53
|
+
\`\`\`bash
|
|
54
|
+
# List every registered topic
|
|
55
|
+
vibes docs list
|
|
56
|
+
|
|
57
|
+
# Filter by tag or parent
|
|
58
|
+
vibes docs list --tag tools
|
|
59
|
+
vibes docs list --parent runtime
|
|
60
|
+
|
|
61
|
+
# Show a topic as man-page
|
|
62
|
+
vibes docs show <topic-id>
|
|
63
|
+
vibes man <topic-id>
|
|
64
|
+
\`\`\`
|
|
65
|
+
|
|
66
|
+
## Related topics
|
|
67
|
+
|
|
68
|
+
- [\`docs.directives\`](docs.directives) — \`:::card\`, \`:::endpoint\` and other markdown directives
|
|
69
|
+
- [\`docs.cli\`](docs.cli) — \`vibes docs\` and \`vibes man\` command reference
|
|
70
|
+
- [\`runtime.query\`](runtime.query) — how topics are discovered at runtime
|
|
71
|
+
`;
|
|
72
|
+
const descriptor = {
|
|
73
|
+
kind: 'docs/topic',
|
|
74
|
+
id: 'docs.topics',
|
|
75
|
+
title: 'Docs Topics',
|
|
76
|
+
summary: 'The docs/topic runtime kind — discoverable, addressable units of user-facing documentation',
|
|
77
|
+
body: {
|
|
78
|
+
type: 'markdown',
|
|
79
|
+
sourceType: 'raw',
|
|
80
|
+
source: docsTopicsMarkdown
|
|
81
|
+
},
|
|
82
|
+
parent: 'docs',
|
|
83
|
+
order: 1,
|
|
84
|
+
tags: ['docs', 'topics', 'descriptors', 'runtime'],
|
|
85
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
86
|
+
hardware: ['consumer'],
|
|
87
|
+
enabled: true
|
|
88
|
+
};
|
|
89
|
+
export default descriptor;
|
|
90
|
+
//# sourceMappingURL=docs.topics.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs.topics.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/docs.topics.docs.descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmE1B,CAAC;AAEF,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,YAAqB;IAC3B,EAAE,EAAE,aAAa;IACjB,KAAK,EAAE,aAAa;IACpB,OAAO,EAAE,4FAA4F;IACrG,IAAI,EAAE;QACJ,IAAI,EAAE,UAAmB;QACzB,UAAU,EAAE,KAAc;QAC1B,MAAM,EAAE,kBAAkB;KAC3B;IACD,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC;IAClD,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU;IAC3C,QAAQ,EAAE,CAAC,UAAU,CAAU;IAC/B,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
declare const descriptor: {
|
|
2
|
+
kind: "docs/topic";
|
|
3
|
+
id: string;
|
|
4
|
+
parent: string;
|
|
5
|
+
order: number;
|
|
6
|
+
title: string;
|
|
7
|
+
summary: string;
|
|
8
|
+
tags: string[];
|
|
9
|
+
surfaces: readonly ["cli", "web", "in-app"];
|
|
10
|
+
hardware: readonly ["consumer", "cloud"];
|
|
11
|
+
enabled: boolean;
|
|
12
|
+
body: {
|
|
13
|
+
type: "markdown";
|
|
14
|
+
sourceType: "raw";
|
|
15
|
+
source: string;
|
|
16
|
+
};
|
|
17
|
+
man: {
|
|
18
|
+
name: string;
|
|
19
|
+
section: number;
|
|
20
|
+
synopsis: string;
|
|
21
|
+
options: never[];
|
|
22
|
+
examples: {
|
|
23
|
+
description: string;
|
|
24
|
+
command: string;
|
|
25
|
+
}[];
|
|
26
|
+
seeAlso: string[];
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
export default descriptor;
|
|
30
|
+
//# sourceMappingURL=fleet-pairing-direct.docs.descriptor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fleet-pairing-direct.docs.descriptor.d.ts","sourceRoot":"","sources":["../../src/docs/fleet-pairing-direct.docs.descriptor.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Ff,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
const descriptor = {
|
|
2
|
+
kind: 'docs/topic',
|
|
3
|
+
id: 'fleet-pairing.direct',
|
|
4
|
+
parent: 'fleet-pairing',
|
|
5
|
+
order: 1,
|
|
6
|
+
title: 'Direct-IP Discovery',
|
|
7
|
+
summary: 'Register an operator-supplied host:port or https:// origin as a runtime/rpc target',
|
|
8
|
+
tags: ['fleet', 'discovery', 'direct', 'runtime-rpc'],
|
|
9
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
10
|
+
hardware: ['consumer', 'cloud'],
|
|
11
|
+
enabled: true,
|
|
12
|
+
body: {
|
|
13
|
+
type: 'markdown',
|
|
14
|
+
sourceType: 'raw',
|
|
15
|
+
source: `---
|
|
16
|
+
title: Direct-IP Discovery
|
|
17
|
+
summary: Register an operator-supplied host:port or https:// origin as a runtime/rpc target
|
|
18
|
+
tags: [fleet, discovery, direct, runtime-rpc]
|
|
19
|
+
parent: fleet-pairing
|
|
20
|
+
order: 1
|
|
21
|
+
id: fleet-pairing.direct
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# Direct-IP Discovery (\`fleet/discovery/direct\`)
|
|
25
|
+
|
|
26
|
+
The simplest discovery adapter: an operator supplies a host address and the
|
|
27
|
+
adapter registers a \`runtime/rpc\` descriptor for it. No socket scan, no cloud
|
|
28
|
+
call, no liveness probe — reachability is verified later by the
|
|
29
|
+
resolver/connect.
|
|
30
|
+
|
|
31
|
+
## Setup
|
|
32
|
+
|
|
33
|
+
\`\`\`ts
|
|
34
|
+
import { createDirectDiscoveryAdapter } from '@vibesdotdev/platform/fleets/pairing/direct';
|
|
35
|
+
import { startFleetBootstrap } from '@vibesdotdev/platform/fleets/bootstrap';
|
|
36
|
+
|
|
37
|
+
const adapter = createDirectDiscoveryAdapter([
|
|
38
|
+
{ id: 'edge-1', address: '10.0.0.5:7777' },
|
|
39
|
+
{ id: 'edge-v6', address: '[2001:db8::1]:9000' },
|
|
40
|
+
{ id: 'box', address: 'https://box.lan', auth: { source: 'secret', key: 'box-lan-token' } }
|
|
41
|
+
]);
|
|
42
|
+
|
|
43
|
+
// The owning app supplies its reachable-runtime registry; the loop runs on the
|
|
44
|
+
// handed runtime's lifecycle.
|
|
45
|
+
const bootstrap = startFleetBootstrap([adapter], registry, { lifecycle: runtime.lifecycle });
|
|
46
|
+
\`\`\`
|
|
47
|
+
|
|
48
|
+
## Bootstrap lifecycle
|
|
49
|
+
|
|
50
|
+
\`startFleetBootstrap(adapters, registry, { lifecycle, refreshIntervalMs?, ttlSeconds?, onEvent?, signal? })\`
|
|
51
|
+
takes the owning runtime's \`lifecycle\` (\`runtime.lifecycle\`). The periodic
|
|
52
|
+
refresh (default 60 000 ms) is that runtime's \`lifecycle.interval\`, so its
|
|
53
|
+
disposal clears the tick and stops the loop, as does the optional \`signal\`.
|
|
54
|
+
A finite host refuses the interval (\`lifecycle-interval-finite\`): pass
|
|
55
|
+
\`refreshIntervalMs: Infinity\` there and call \`refresh()\` on demand.
|
|
56
|
+
|
|
57
|
+
## Address forms
|
|
58
|
+
|
|
59
|
+
- \`'10.0.0.5:7777'\` / \`'tcp://box.lan:9000'\` → tcp target
|
|
60
|
+
- \`'[::1]:8080'\` / \`'tcp://[fe80::1]:9000'\` → tcp target (IPv6 must be bracketed)
|
|
61
|
+
- \`'https://box.lan'\` / \`'http://10.0.0.5:8080'\` → http target (origin normalized)
|
|
62
|
+
|
|
63
|
+
A port-less address, an out-of-range port, or an unbracketed bare IPv6
|
|
64
|
+
literal throws — a direct target must be concrete and is never guessed at.
|
|
65
|
+
|
|
66
|
+
## Credentials
|
|
67
|
+
|
|
68
|
+
\`auth\` on a host input is a **CredentialReference** into secrets/store, never
|
|
69
|
+
a bare token; the transport resolves it at connect time.
|
|
70
|
+
|
|
71
|
+
## Lifecycle
|
|
72
|
+
|
|
73
|
+
None. The adapter has no \`destroy\` — it did not create the host. If the
|
|
74
|
+
operator-supplied host is a provisioned sandbox, \`infra/sandbox\` owns its
|
|
75
|
+
teardown.
|
|
76
|
+
`
|
|
77
|
+
},
|
|
78
|
+
man: {
|
|
79
|
+
name: 'fleet-pairing.direct — direct-IP fleet discovery',
|
|
80
|
+
section: 1,
|
|
81
|
+
synopsis: 'vibes man fleet-pairing.direct',
|
|
82
|
+
options: [],
|
|
83
|
+
examples: [
|
|
84
|
+
{
|
|
85
|
+
description: 'Create a direct discovery adapter for fleet bootstrap',
|
|
86
|
+
command: "createDirectDiscoveryAdapter([{ id: 'edge-1', address: '10.0.0.5:7777' }])"
|
|
87
|
+
}
|
|
88
|
+
],
|
|
89
|
+
seeAlso: ['fleet-pairing', 'fleet-pairing.mdns', 'fleet-pairing.platform']
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
export default descriptor;
|
|
93
|
+
//# sourceMappingURL=fleet-pairing-direct.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fleet-pairing-direct.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/fleet-pairing-direct.docs.descriptor.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAAG;IAClB,IAAI,EAAE,YAAqB;IAC3B,EAAE,EAAE,sBAAsB;IAC1B,MAAM,EAAE,eAAe;IACvB,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,qBAAqB;IAC5B,OAAO,EAAE,oFAAoF;IAC7F,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,CAAC;IACrD,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU;IAC3C,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAU;IACxC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE;QACL,IAAI,EAAE,UAAmB;QACzB,UAAU,EAAE,KAAc;QAC1B,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DT;KACC;IACD,GAAG,EAAE;QACJ,IAAI,EAAE,kDAAkD;QACxD,OAAO,EAAE,CAAC;QACV,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE;YACT;gBACC,WAAW,EAAE,uDAAuD;gBACpE,OAAO,EAAE,4EAA4E;aACrF;SACD;QACD,OAAO,EAAE,CAAC,eAAe,EAAE,oBAAoB,EAAE,wBAAwB,CAAC;KAC1E;CACD,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
declare const descriptor: {
|
|
2
|
+
kind: "docs/topic";
|
|
3
|
+
id: string;
|
|
4
|
+
parent: string;
|
|
5
|
+
order: number;
|
|
6
|
+
title: string;
|
|
7
|
+
summary: string;
|
|
8
|
+
tags: string[];
|
|
9
|
+
surfaces: readonly ["cli", "web", "in-app"];
|
|
10
|
+
hardware: readonly ["consumer"];
|
|
11
|
+
enabled: boolean;
|
|
12
|
+
body: {
|
|
13
|
+
type: "markdown";
|
|
14
|
+
sourceType: "raw";
|
|
15
|
+
source: string;
|
|
16
|
+
};
|
|
17
|
+
man: {
|
|
18
|
+
name: string;
|
|
19
|
+
section: number;
|
|
20
|
+
synopsis: string;
|
|
21
|
+
options: never[];
|
|
22
|
+
examples: {
|
|
23
|
+
description: string;
|
|
24
|
+
command: string;
|
|
25
|
+
}[];
|
|
26
|
+
seeAlso: string[];
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
export default descriptor;
|
|
30
|
+
//# sourceMappingURL=fleet-pairing-mdns.docs.descriptor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fleet-pairing-mdns.docs.descriptor.d.ts","sourceRoot":"","sources":["../../src/docs/fleet-pairing-mdns.docs.descriptor.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqFf,CAAC;AAEF,eAAe,UAAU,CAAC"}
|