Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .claude/settings.local.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"permissions": {
"allow": [
"mcp__filesystem__list_directory",
"mcp__filesystem__directory_tree",
"Bash(npx docusaurus build)",
"mcp__filesystem__read_text_file",
"Bash(npm run build)",
"mcp__Claude_Preview__preview_start",
"Bash(curl -s -o /dev/null -w \"%{http_code}\" http://localhost:3333/)",
"mcp__playwright__browser_navigate",
"mcp__playwright__browser_take_screenshot",
"mcp__playwright__browser_console_messages",
"mcp__playwright__browser_click",
"Bash(where npx.cmd)",
"Bash(where npx)",
"Bash(node -e \"console.log\\(process.platform\\)\")",
"Bash(npx kill-port 3333)",
"Bash(lsof -ti:3333)",
"Bash(xargs kill -9)",
"Bash(netstat -ano)",
"Bash(node node_modules/@docusaurus/core/bin/docusaurus.mjs build)",
"mcp__playwright__browser_snapshot",
"Bash(node -e \"JSON.parse\\(require\\(''fs''\\).readFileSync\\(''D:/Repos/Reveal/Documentation/i18n/en/code.json'',''utf8''\\)\\); console.log\\(''Valid JSON''\\)\")",
"mcp__playwright__browser_wait_for",
"Bash(node -e \"JSON.parse\\(require\\(''fs''\\).readFileSync\\(''D:/Repos/Reveal/Documentation/i18n/ja/code.json'',''utf8''\\)\\); console.log\\(''Valid JSON''\\)\")"
]
}
}
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A web application that:

Before you begin, ensure you meet the [System Requirements](system-requirements.md) and have:

1. [Reveal SDK Server](../install-server-sdk.md) installed and configured
1. [Reveal SDK Server](/web/install-server-sdk) installed and configured
2. [Reveal SDK AI Server](install-server-sdk.md) installed
3. **LLM Provider API Key** from [OpenAI](https://platform.openai.com/api-keys), [Anthropic](https://platform.anthropic.com/account/keys), or [Google Cloud](https://cloud.google.com/vertex-ai)

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Reveal SDK AI Client is a TypeScript/JavaScript library that provides AI cap

Before installing the AI Client SDK, ensure you have:

1. The base [Reveal SDK Server](../install-server-sdk.md) installed and configured
1. The base [Reveal SDK Server](/web/install-server-sdk) installed and configured
2. The [Reveal SDK AI Server](install-server-sdk.md) installed and configured
3. Node.js 18+ and npm 9+ installed (for package-based installation)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Reveal SDK AI Server provides the backend services needed to power AI featur

Before installing the AI Server SDK, ensure you have:

1. The base [Reveal SDK Server](../install-server-sdk.md) installed and configured
1. The base [Reveal SDK Server](/web/install-server-sdk) installed and configured
2. .NET 8.0 or higher
3. Access to at least one LLM provider (OpenAI, Anthropic, Google, etc.)
4. LLM provider API keys configured
Expand All @@ -29,7 +29,7 @@ The AI Server SDK for ASP.NET Core is distributed as a NuGet package.

Right-click your Solution or Project and select **Manage NuGet Packages** for Solution.

![](../images/getting-started-nuget-packages-manage.jpg)
![](../web/images/getting-started-nuget-packages-manage.jpg)

In the package manager dialog, open the **Browse** tab and install the **Reveal.Sdk.AI.AspNetCore** NuGet package into your project.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 5 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ const config: Config = {
position: "left",
items: [
{ label: "Web", to: "web" },
{ label: "AI", to: "ai/overview" },
{ label: "User", to: "user" },
]
},
Expand Down Expand Up @@ -135,6 +136,10 @@ const config: Config = {
label: 'Web SDK',
to: 'web',
},
{
label: 'AI SDK',
to: 'ai/overview',
},
{ label: "User", to: "user" },
],
},
Expand Down
150 changes: 125 additions & 25 deletions i18n/en/code.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,135 @@
{
"homepage.hero.title": {
"message": "New to Reveal? We've got you covered!",
"message": "Build Intelligent Analytics Into Your Apps",
"description": "The title of the hero section on the homepage"
},
"homepage.hero.subtitle": {
"message": "Get help with integration, data visualization design, dashboard creation, and more.",
"message": "Embed interactive dashboards, AI-powered insights, and conversational data exploration into any web application.",
"description": "The subtitle of the hero section on the homepage"
},
"homepage.feature.web": {
"message": "Embed data analytics into your HTML/JavaScript, Angular, React, or ASP.NET web applications.",
"description": "The words used to describe the web sdk on the homepage"
"homepage.hero.cta.getStarted": {
"message": "Get Started",
"description": "The primary CTA button on the homepage hero"
},
"homepage.hero.cta.exploreAi": {
"message": "Explore AI SDK",
"description": "The secondary CTA button on the homepage hero"
},
"homepage.ai.badge": {
"message": "NEW",
"description": "The badge label for the AI spotlight section"
},
"homepage.ai.title": {
"message": "AI-Powered Analytics",
"description": "The title of the AI spotlight section"
},
"homepage.ai.description": {
"message": "Generate dashboards from natural language, get AI insights from your data, and build conversational analytics — all with a few lines of code.",
"description": "The description in the AI spotlight section"
},
"homepage.ai.capability1": {
"message": "Natural Language Dashboards",
"description": "AI capability chip 1"
},
"homepage.ai.capability2": {
"message": "AI Insights & Forecasts",
"description": "AI capability chip 2"
},
"homepage.ai.capability3": {
"message": "Conversational Chat",
"description": "AI capability chip 3"
},
"homepage.ai.cta": {
"message": "Start building with AI",
"description": "The CTA link in the AI spotlight section"
},
"homepage.sdk.web.title": {
"message": "Web SDK",
"description": "The title of the Web SDK card"
},
"homepage.sdk.web.subtitle": {
"message": "Embedded Analytics",
"description": "The subtitle of the Web SDK card"
},
"homepage.sdk.web.description": {
"message": "Embed interactive dashboards and data visualizations into any web application. Supports 30+ data sources with full customization.",
"description": "The description of the Web SDK card"
},
"homepage.sdk.web.link.getStarted": {
"message": "Getting Started",
"description": "Web SDK quick link"
},
"homepage.sdk.web.link.dataSources": {
"message": "Data Sources",
"description": "Web SDK quick link"
},
"homepage.sdk.web.link.apiRef": {
"message": "API Reference",
"description": "Web SDK quick link"
},
"homepage.sdk.web.link.playground": {
"message": "Developer Playground",
"description": "Web SDK quick link"
},
"homepage.sdk.ai.title": {
"message": "AI SDK",
"description": "The title of the AI SDK card"
},
"homepage.sdk.ai.subtitle": {
"message": "Intelligent Analytics",
"description": "The subtitle of the AI SDK card"
},
"homepage.sdk.ai.description": {
"message": "Add AI-powered insights, natural language dashboards, and conversational analytics using LLMs like OpenAI, Anthropic, and Google.",
"description": "The description of the AI SDK card"
},
"homepage.sdk.ai.link.overview": {
"message": "Overview",
"description": "AI SDK quick link"
},
"homepage.sdk.ai.link.getStarted": {
"message": "Getting Started",
"description": "AI SDK quick link"
},
"homepage.sdk.ai.link.insights": {
"message": "Insights API",
"description": "AI SDK quick link"
},
"homepage.sdk.ai.link.chat": {
"message": "Chat API",
"description": "AI SDK quick link"
},
"homepage.frameworks.title": {
"message": "Choose Your Stack",
"description": "The title of the framework picker section"
},
"homepage.frameworks.subtitle": {
"message": "Step-by-step getting started guides for your preferred framework.",
"description": "The subtitle of the framework picker section"
},
"homepage.frameworks.html": {
"message": "HTML / JavaScript",
"description": "Framework picker label"
},
"homepage.frameworks.react": {
"message": "React",
"description": "Framework picker label"
},
"homepage.frameworks.angular": {
"message": "Angular",
"description": "Framework picker label"
},
"homepage.frameworks.aspnet": {
"message": "ASP.NET",
"description": "Framework picker label"
},
"homepage.frameworks.node": {
"message": "Node.js",
"description": "Framework picker label"
},
"homepage.frameworks.springboot": {
"message": "Spring Boot",
"description": "Framework picker label"
},
"theme.ErrorPageContent.title": {
"message": "This page crashed.",
Expand Down Expand Up @@ -266,10 +386,6 @@
"message": "Tags",
"description": "The title of the tag list page"
},
"homepage.feature.web.title": {
"message": "Web SDK Documentation",
"description": "The title of the Web feature on the homepage"
},
"playground.runButton": {
"message": "Run"
},
Expand Down Expand Up @@ -356,14 +472,6 @@
"message": "Docs sidebar",
"description": "The ARIA label for the sidebar navigation"
},
"homepage.feature.user.title": {
"message": "User Documentation",
"description": "The title of the User Docs feature on the homepage"
},
"homepage.feature.user": {
"message": "Explore user-friendly guides and resources tailored for end-users to make the most of data analytics.",
"description": "The words used to describe the user section on the homepage"
},
"theme.docs.DocCard.categoryDescription.plurals": {
"message": "1 item|{count} items",
"description": "The default description for a category card in the generated index about how many items this category includes"
Expand Down Expand Up @@ -543,14 +651,6 @@
"message": "This page is a draft. It will only be visible in dev and be excluded from the production build.",
"description": "The draft content banner message"
},
"homepage.feature.video.title": {
"message": "Videos",
"description": "The title of the Video feature on the homepage"
},
"homepage.feature.video": {
"message": "Dive into Reveal SDK with step‑by‑step YouTube videos. Hit play and ship your first dashboard today.",
"description": "The words used to describe the video section on the homepage"
},
"theme.colorToggle.ariaLabel.mode.system": {
"message": "system mode",
"description": "The name for the system color mode"
Expand Down
104 changes: 52 additions & 52 deletions i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -543,66 +543,14 @@
"message": "Databricks",
"description": "The label for the doc item 'Databricks' in sidebar 'webSidebar', linking to the doc web/adding-data-sources/databricks"
},
"sidebar.webSidebar.category.Reveal SDK AI": {
"message": "Reveal SDK AI",
"description": "The label for category 'Reveal SDK AI' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.category.Features": {
"message": "Features",
"description": "The label for category 'Features' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.doc.Elasticsearch": {
"message": "Elasticsearch",
"description": "The label for the doc item 'Elasticsearch' in sidebar 'webSidebar', linking to the doc web/adding-data-sources/elasticsearch"
},
"sidebar.webSidebar.doc.Insights": {
"message": "Insights",
"description": "The label for the doc item 'Insights' in sidebar 'webSidebar', linking to the doc web/ai/insights"
},
"sidebar.webSidebar.doc.Chat": {
"message": "Chat",
"description": "The label for the doc item 'Chat' in sidebar 'webSidebar', linking to the doc web/ai/chat"
},
"sidebar.webSidebar.category.Configuration": {
"message": "Configuration",
"description": "The label for category 'Configuration' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.doc.Metadata Catalog": {
"message": "Metadata Catalog",
"description": "The label for the doc item 'Metadata Catalog' in sidebar 'webSidebar', linking to the doc web/ai/metadata-catalog"
},
"sidebar.webSidebar.category.reveal-sdk-ai-installation": {
"message": "Installation",
"description": "The label for category 'Installation' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.category.reveal-sdk-ai-getting-started": {
"message": "Getting Started",
"description": "The label for category 'Getting Started' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.category.web-component-wrappers-installation": {
"message": "Installation",
"description": "The label for category 'Installation' in sidebar 'webSidebar'"
},
"sidebar.webSidebar.doc.reveal-sdk-ai-overview": {
"message": "Overview",
"description": "The label for the doc item 'Overview' in sidebar 'webSidebar', linking to the doc web/ai/overview"
},
"sidebar.webSidebar.doc.reveal-sdk-ai-system-requirements": {
"message": "System Requirements",
"description": "The label for the doc item 'System Requirements' in sidebar 'webSidebar', linking to the doc web/ai/system-requirements"
},
"sidebar.webSidebar.doc.reveal-sdk-ai-install-server-sdk": {
"message": "Install Server SDK",
"description": "The label for the doc item 'Install Server SDK' in sidebar 'webSidebar', linking to the doc web/ai/install-server-sdk"
},
"sidebar.webSidebar.doc.reveal-sdk-ai-install-client-sdk": {
"message": "Install Client SDK",
"description": "The label for the doc item 'Install Client SDK' in sidebar 'webSidebar', linking to the doc web/ai/install-client-sdk"
},
"sidebar.webSidebar.doc.reveal-sdk-ai-getting-started-html": {
"message": "HTML/JavaScript",
"description": "The label for the doc item 'HTML/JavaScript' in sidebar 'webSidebar', linking to the doc web/ai/getting-started-html"
},
"sidebar.webSidebar.doc.web-component-wrappers-overview": {
"message": "Overview",
"description": "The label for the doc item 'Overview' in sidebar 'webSidebar', linking to the doc web/web-component-wrappers/index"
Expand Down Expand Up @@ -638,5 +586,57 @@
"sidebar.userSideBar.doc.user-tutorials-text-view": {
"message": "Text View",
"description": "The label for the doc item 'Text View' in sidebar 'userSideBar', linking to the doc user/tutorials-text-view"
},
"sidebar.aiSidebar.category.ai-getting-started-header": {
"message": "Getting Started",
"description": "The label for category 'Getting Started' in sidebar 'aiSidebar'"
},
"sidebar.aiSidebar.category.Installation": {
"message": "Installation",
"description": "The label for category 'Installation' in sidebar 'aiSidebar'"
},
"sidebar.aiSidebar.category.ai-getting-started-tutorials": {
"message": "Getting Started",
"description": "The label for category 'Getting Started' in sidebar 'aiSidebar'"
},
"sidebar.aiSidebar.category.Metadata": {
"message": "Metadata",
"description": "The label for category 'Metadata' in sidebar 'aiSidebar'"
},
"sidebar.aiSidebar.category.Features": {
"message": "Features",
"description": "The label for category 'Features' in sidebar 'aiSidebar'"
},
"sidebar.aiSidebar.doc.Overview": {
"message": "Overview",
"description": "The label for the doc item 'Overview' in sidebar 'aiSidebar', linking to the doc ai/overview"
},
"sidebar.aiSidebar.doc.System Requirements": {
"message": "System Requirements",
"description": "The label for the doc item 'System Requirements' in sidebar 'aiSidebar', linking to the doc ai/system-requirements"
},
"sidebar.aiSidebar.doc.Install Server SDK": {
"message": "Install Server SDK",
"description": "The label for the doc item 'Install Server SDK' in sidebar 'aiSidebar', linking to the doc ai/install-server-sdk"
},
"sidebar.aiSidebar.doc.Install Client SDK": {
"message": "Install Client SDK",
"description": "The label for the doc item 'Install Client SDK' in sidebar 'aiSidebar', linking to the doc ai/install-client-sdk"
},
"sidebar.aiSidebar.doc.HTML/JavaScript": {
"message": "HTML/JavaScript",
"description": "The label for the doc item 'HTML/JavaScript' in sidebar 'aiSidebar', linking to the doc ai/getting-started-html"
},
"sidebar.aiSidebar.doc.Metadata Catalog": {
"message": "Metadata Catalog",
"description": "The label for the doc item 'Metadata Catalog' in sidebar 'aiSidebar', linking to the doc ai/metadata-catalog"
},
"sidebar.aiSidebar.doc.Insights": {
"message": "Insights",
"description": "The label for the doc item 'Insights' in sidebar 'aiSidebar', linking to the doc ai/insights"
},
"sidebar.aiSidebar.doc.Chat": {
"message": "Chat",
"description": "The label for the doc item 'Chat' in sidebar 'aiSidebar', linking to the doc ai/chat"
}
}
Loading