26.5.0.cl docs publication

gatsby-config.js

@@ -192,6 +192,7 @@ module.exports = {
                     .queries,
                 // for testing add dryRun as true,
                 // dryRun: true,
+                continueOnFailure: !process.env.ALGOLIA_ADMIN_KEY,
             },
         },
         {

gatsby-node.js

@@ -3,14 +3,123 @@ const {
     DOC_NAV_PAGE_ID,
     NOT_FOUND_PAGE_ID,
     VERSION_DROPDOWN,
+    SITE_URL,
+    LLMS_SECTIONS,
 } = require('./src/configs/doc-configs');
 const { getDocLinkFromEdge } = require('./src/utils/gatsby-utils.js');
 
-exports.onPostBuild = () => {
+/* ── Build-time Markdown generation ───────────────────────────────────────
+ * For every asciidoc node, convert the already-generated HTML to clean
+ * Markdown using cheerio (DOM pre-processing) + turndown (HTML→MD).
+ * The result is stored as `fields.markdownBody` on each node and exposed
+ * in GraphQL so CopyPageDropdown can use it instead of scraping the DOM.
+ */
+exports.onCreateNode = ({ node, actions }) => {
+    if (node.internal.type !== 'Asciidoc') return;
+
+    const { createNodeField } = actions;
+    const TurndownService = require('turndown');
+    const cheerio = require('cheerio');
+
+    const html = node.html || '';
+    const title = node.document?.title || node.pageAttributes?.title || '';
+
+    /* Load HTML into cheerio for pre-processing */
+    const $ = cheerio.load(html, { decodeEntities: false });
+
+    /* Remove anchor icon links that Asciidoctor injects next to headings */
+    $('a.anchor').remove();
+
+    /* Remove the embedded TOC — it adds noise to Markdown */
+    $('#toc').remove();
+
+    /* Convert admonition tables to readable text blocks */
+    $('.admonitionblock').each((_, el) => {
+        const type = $(el).attr('class').match(/\b(note|tip|warning|caution|important)\b/i)?.[1]?.toUpperCase() || 'NOTE';
+        const content = $(el).find('td.content').text().trim();
+        $(el).replaceWith(`<blockquote><p><strong>${type}:</strong> ${content}</p></blockquote>`);
+    });
+
+    /* Get the cleaned HTML */
+    const cleanedHtml = $('body').html() || '';
+
+    /* Configure turndown */
+    const td = new TurndownService({
+        headingStyle: 'atx',
+        bulletListMarker: '-',
+        codeBlockStyle: 'fenced',
+        fence: '```',
+    });
+
+    /* GFM table plugin — renders tables as proper Markdown pipe tables */
+    const { tables } = require('turndown-plugin-gfm');
+    td.use(tables);
+
+    const markdownBody = td.turndown(cleanedHtml);
+
+    createNodeField({
+        node,
+        name: 'markdownBody',
+        value: markdownBody,
+    });
+};
+
+exports.onPostBuild = async ({ graphql, reporter }) => {
     fsExtra.copyFileSync(
         `${__dirname}/robots.txt`,
         `${__dirname}/public/robots.txt`,
     );
+
+    try {
+        const result = await graphql(`
+            query {
+                allAsciidoc {
+                    edges {
+                        node {
+                            document { title }
+                            pageAttributes { pageid }
+                        }
+                    }
+                }
+            }
+        `);
+
+        if (result.errors) {
+            reporter.warn(`llms.txt generation: GraphQL errors — ${JSON.stringify(result.errors)}`);
+            return;
+        }
+
+        const pageMap = {};
+        result.data.allAsciidoc.edges.forEach(({ node }) => {
+            const pageid = node.pageAttributes?.pageid;
+            const title = node.document?.title;
+            if (pageid && title) pageMap[pageid] = title;
+        });
+
+        const lines = [
+            '# ThoughtSpot Developer Documentation',
+            '',
+            '> Developer documentation for ThoughtSpot Embedded — tools, APIs, and SDKs for embedding ThoughtSpot analytics into your applications.',
+            '',
+        ];
+
+        for (const section of LLMS_SECTIONS) {
+            lines.push(`## ${section.label}`);
+            for (const pageId of section.pageIds) {
+                const title = pageMap[pageId];
+                if (title) lines.push(`- [${title}](${SITE_URL}/${pageId})`);
+            }
+            lines.push('');
+        }
+
+        fsExtra.writeFileSync(
+            `${__dirname}/public/llms.txt`,
+            lines.join('\n'),
+        );
+        reporter.info(`llms.txt generated with ${Object.keys(pageMap).length} pages`);
+    } catch (err) {
+        reporter.warn(`llms.txt generation failed: ${err.message}`);
+    }
 };
 exports.createPages = async function ({ actions, graphql }) {
     const { data } = await graphql(`
@@ -39,12 +148,23 @@ exports.createPages = async function ({ actions, graphql }) {
     `);
 
     const namePageIdMap = {};
+    // Collect per-category nav HTMLs keyed by category name (pageid minus 'nav-' prefix)
+    const navMap = {};
+    const NAV_PARTIAL_PREFIX = 'nav-';
+
     data.allAsciidoc.edges.forEach((e) => {
         const {
             sourceInstanceName: sourceName,
             relativePath: relPath,
         } = e.node.parent;
         const pageId = e.node.pageAttributes.pageid;
+
+        // Collect nav-* files into the navMap (not content pages)
+        if (pageId && pageId.startsWith(NAV_PARTIAL_PREFIX)) {
+            navMap[pageId.slice(NAV_PARTIAL_PREFIX.length)] = e.node.html;
+            return;
+        }
+
         if (sourceName === 'tutorials') {
             const relPathSplit = relPath.split('/');
             const pageIdSplit = pageId.split('__');
@@ -66,13 +186,16 @@ exports.createPages = async function ({ actions, graphql }) {
     data.allAsciidoc.edges.forEach((edge) => {
         const { pageid: pageId } = edge.node.pageAttributes;
 
+        // Skip nav partial files — they are sidebar data, not content pages
+        if (pageId && pageId.startsWith(NAV_PARTIAL_PREFIX)) return;
+
         const docPath = getDocLinkFromEdge(edge);
         actions.createPage({
             path: docPath,
             component: require.resolve(
                 './src/components/DevDocTemplate/index.tsx',
             ),
-            context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap },
+            context: { pageId, navId: DOC_NAV_PAGE_ID, navMap, namePageIdMap },
         });
 
         if (pageId === 'introduction') {
@@ -81,7 +204,7 @@ exports.createPages = async function ({ actions, graphql }) {
                 component: require.resolve(
                     './src/components/DevDocTemplate/index.tsx',
                 ),
-                context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap },
+                context: { pageId, navId: DOC_NAV_PAGE_ID, navMap, namePageIdMap },
             });
         }
     });

modules/ROOT/pages/ai-integration-options.adoc

@@ -1,4 +1,4 @@
-= ThoughtSpot AI analytics integration
+= AI analytics integration
 :toc: true
 :toclevels: 3
 

modules/ROOT/pages/api-changelog.adoc

@@ -19,6 +19,7 @@ The SDK includes the following new features and enhancements in Liveboard embedd
 
 Continuous Liveboard layout in PDF downloads [beta betaBackground]^Beta^::
 
+
 When set to `true`, the `isContinuousLiveboardPDFEnabled` enables the Liveboard tab to render on a single page that matches the exact UI layout you see in ThoughtSpot. This update addresses the issue where visualizations for PDF downloads were split across multiple A4 pages regardless of how they appear on screen. This feature is in beta and can be enabled by setting `isContinuousLiveboardPDFEnabled` to `true`.
 
 New events and action IDs;;
@@ -99,6 +100,7 @@ The following events are deprecated and replaced with new event IDs.
 * `Action.PersonalisedViewsDropdown`. Use `Action.PersonalizedViewsDropdown`.
 * `Action.OrganiseFavourites`. Use `Action.OrganizeFavorites`.
 
+
 |====
 
 
@@ -241,7 +243,7 @@ Is emitted when a saved chat is deleted.
 * `EmbedEvent.SpotterConversationSelected` +
 Is emitted when a saved chat is selected in the chat history sidebar.
 
-|[tag greenBackground]#NEW FEATURE# | `enableLinkOverridesV2`  +
+|[tag greenBackground]#NEW FEATURE# | `enableLinkOverridesV2` +
 
 Use this configuration setting to override ThoughtSpot URLs on hover or when opening in a new tab. This is recommended over the earlier `linkOverride` flag for a better user experience.
 
@@ -713,7 +715,7 @@ For more information about Spotter customization, see xref:embed-spotter.adoc#Sp
 |[tag greenBackground]#NEW FEATURE# a|
 
 
-Configurations attributes::
+Configuration attributes::
 
 * `hideIrrelevantChipsInLiveboardTabs` +
 Hides filter chips on a Liveboard when set to `true`.

modules/ROOT/pages/common/nav-embedding.adoc

@@ -116,7 +116,7 @@ Authentication and data security
 * link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors]
 
 [.sidebar-title]
-Authentication and data security
+Embedding tutorials
 
 * link:{{navprefix}}/tutorials/tutorials-overview[Embedding tutorials]
 * link:{{navprefix}}/tutorials/tse-fundamentals/intro[Embedding Fundamentals]

modules/ROOT/pages/common/nav-mcp-server.adoc

@@ -0,0 +1,32 @@
+
+:page-pageid: nav-mcp-server
+:page-description: MCP Server navigation
+
+[navSection]
+
+[.sidebar-title]
+ThoughtSpot MCP server
+
+* link:{{navprefix}}/mcp-integration[Overview]
+** link:{{navprefix}}/mcp-server-spotter3[MCP Server with Spotter 3]
+** link:{{navprefix}}/mcp-server-legacy[Legacy MCP Server architecture and tools]
+* link:{{navprefix}}/connect-mcp-server-to-clients[Connecting MCP Server to MCP clients]
+* link:{{navprefix}}/custom-chatbot-integration-mcp[Integrating MCP Server in a custom app]
+
+[.sidebar-title]
+MCP tools reference
+
+* link:{{navprefix}}/mcp-tool-reference[Overview]
+* link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (Spotter 3)]
+* link:{{navprefix}}/mcp-tool-reference-spotter3[MCP tool reference (legacy version)]
+
+[.sidebar-title]
+Related SDK components
+
+* [.typedoc-Function]#link:{{navprefix}}/Function_startAutoMCPFrameRenderer[startAutoMCPFrameRenderer]#
+* [.typedoc-Interface]#link:{{navprefix}}/Interface_AutoMCPFrameRendererViewConfig[AutoMCPFrameRendererViewConfig]#
+
+[.sidebar-title]
+MCP Server release notes
+
+* link:{{navprefix}}/mcp-server-changelog[MCP Server changelog]

modules/ROOT/pages/common/nav-rest-api.adoc

@@ -0,0 +1,96 @@
+
+:page-pageid: nav-rest-api
+:page-description: REST API navigation
+
+[navSection]
+
+[.sidebar-title]
+REST APIs
+
+* link:{{navprefix}}/rest-apis[Overview]
+* link:{{navprefix}}/rest-apiv2-getstarted[Get started]
+* link:{{navprefix}}/api-authv2[REST API v2.0 authentication]
+* link:{{navprefix}}/rest-v2-changelog[REST API v2 changelog]
+* link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground]
+* link:{{navprefix}}/rest-apiv2-reference[REST API v2.0 Reference]
+** link:{{navprefix}}/api-user-management[Users and group privileges]
+** link:{{navprefix}}/rbac[Role-based access control]
+** link:{{navprefix}}/rest-apiv2-search[Search API endpoints]
+*** link:{{navprefix}}/rest-apiv2-users-search[Search users]
+*** link:{{navprefix}}/rest-apiv2-groups-search[Search groups]
+*** link:{{navprefix}}/rest-apiv2-metadata-search[Search metadata]
+** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs]
+** link:{{navprefix}}/spotter-api[Spotter APIs]
+*** link:{{navprefix}}/spotter-agent-apis[AI APIs (Spotter Agent and Spotter 3)]
+*** link:{{navprefix}}/spotter-apis-classic[AI APIs (Spotter Classic) ^BETA^]
+*** link:{{navprefix}}/spotter-coaching-apis[Spotter coaching APIs ^BETA^]
+** link:{{navprefix}}/audit-logs[Audit logs]
+** link:{{navprefix}}/tml[TML]
+** link:{{navprefix}}/collections[Collections ^BETA^]
+** link:{{navprefix}}/connections[Connections]
+** link:{{navprefix}}/connection-config[Connection configuration]
+** link:{{navprefix}}/runtime-sort[Runtime sorting]
+
+
+[.sidebar-title]
+REST API SDK
+
+* link:{{navprefix}}/rest-api-sdk[Overview]
+* link:{{navprefix}}/rest-api-sdk-typescript[TypeScript SDK]
+* link:{{navprefix}}/rest-api-sdk-java[Java SDK]
+* link:{{navprefix}}/rest-apiv2-js[REST API v2.0 in JavaScript]
+
+[.sidebar-title]
+Webhooks
+
+* link:{{navprefix}}/webhooks[Overview]
+* link:{{navprefix}}/webhooks-comm-channel[Configure and monitor webhook communication channels]
+* link:{{navprefix}}/webhooks-s3-integration[Deliver Liveboard reports to AWS S3 Storage]
+* link:{{navprefix}}/webhooks-lb-schedule[Deliver Liveboard reports to external application]
+* link:{{navprefix}}/webhooks-lb-payload[Webhook response payload]
+* link:{{navprefix}}/webhooks-kpi[Webhook for KPI alerts]
+
+[.sidebar-title]
+REST API Tutorials
+
+* link:{{navprefix}}/tutorials/rest-api/intro[REST API Tutorials]
+* link:{{navprefix}}/tutorials/rest-api/lesson-01[01 - REST API overview]
+* link:{{navprefix}}/tutorials/rest-api/lesson-02[02 - Simple Python implementation]
+* link:{{navprefix}}/tutorials/rest-api/lesson-03[03 - Complex REST API workflows]
+
+[.sidebar-title]
+REST API v1 (DEPRECATED)
+
+* link:{{navprefix}}/rest-api-getstarted[Get started]
+* link:{{navprefix}}/api-auth-session[REST API v1 authentication]
+* link:{{navprefix}}/catalog-and-audit[Catalog and audit content]
+* link:{{navprefix}}/rest-api-pagination[Paginate API response]
+* link:{{navprefix}}/rest-api-reference[REST API v1 Reference]
+** link:{{navprefix}}/orgs-api[Orgs API]
+** link:{{navprefix}}/user-api[User API]
+** link:{{navprefix}}/group-api[Group API]
+** link:{{navprefix}}/role-api[Role API]
+** link:{{navprefix}}/session-api[Session API]
+** link:{{navprefix}}/connections-api[Data connection API]
+** link:{{navprefix}}/metadata-api[Metadata API]
+** link:{{navprefix}}/admin-api[Admin API]
+** link:{{navprefix}}/tml-api[TML API]
+** link:{{navprefix}}/dependent-objects-api[Dependent objects API]
+** link:{{navprefix}}/search-data-api[Search data API]
+** link:{{navprefix}}/liveboard-data-api[Liveboard data API]
+** link:{{navprefix}}/liveboard-export-api[Liveboard export API]
+** link:{{navprefix}}/security-api[Security API]
+** link:{{navprefix}}/logs-api[Audit logs API]
+** link:{{navprefix}}/materialization-api[Materialization API]
+** link:{{navprefix}}/database-api[Database API]
+** link:{{navprefix}}/rest-v1-changelog[REST API v1 changelog]
+** link:{{navprefix}}/v1v2-comparison[REST v1 and v2.0 comparison]
+
+
+//** link:{{navprefix}}/graphql-guide[GraphQL API ^Beta^]
+
+
+
+
+
+

modules/ROOT/pages/common/nav-spottercode.adoc

@@ -0,0 +1,12 @@
+
+:page-pageid: nav-spottercode
+:page-description: SpotterCode navigation
+
+[navSection]
+
+[.sidebar-title]
+SpotterCode agent
+
+* link:{{navprefix}}/SpotterCode[SpotterCode for IDEs]
+* link:{{navprefix}}/integrate-SpotterCode[Integrating SpotterCode]
+* link:{{navprefix}}/spottercode-prompting-guide[SpotterCode prompting guide]