From 0050e373f8b6bee0bdcc8ac567e6175930ff8027 Mon Sep 17 00:00:00 2001 From: dayhaysoos Date: Wed, 24 Apr 2024 14:39:31 -0400 Subject: [PATCH] set up inkeep --- pnpm-lock.yaml | 7 ++++ site/docusaurus.config.js | 82 ++++++++++++++++++++++++++++++++++----- site/package.json | 1 + 3 files changed, 81 insertions(+), 9 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a587bd1c7..3139a02f2 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -505,6 +505,9 @@ importers: '@docusaurus/utils': specifier: 3.1.1 version: 3.1.1(@docusaurus/types@3.1.1) + '@inkeep/docusaurus': + specifier: ^1.0.20 + version: 1.0.20 '@mdx-js/react': specifier: 3.0.1 version: 3.0.1(@types/react@18.2.57)(react@18.2.0) @@ -4028,6 +4031,10 @@ packages: resolution: {integrity: sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==} dev: true + /@inkeep/docusaurus@1.0.20: + resolution: {integrity: sha512-krXJJIgsHLiHKX5iqYtsHRVs7kdQoi3TgxAeq1udQMLCzrI8Q57O8ZG/3h7NZL+jjCM6/4Vdjpf+rAqoXzPmCQ==} + dev: false + /@ioredis/commands@1.2.0: resolution: {integrity: sha512-Sx1pU8EM64o2BrqNpEO1CNLtKQwyhuXuqyfH7oGKCk+1a33d2r5saW8zNwm3j6BTExtjrv2BxTgzzkMwts6vGg==} dev: true diff --git a/site/docusaurus.config.js b/site/docusaurus.config.js index 08f020070..5e74c4b75 100644 --- a/site/docusaurus.config.js +++ b/site/docusaurus.config.js @@ -5,11 +5,14 @@ require('dotenv').config(); const lightCodeTheme = require('prism-react-renderer').themes.github; const darkCodeTheme = require('prism-react-renderer').themes.dracula; const WEB5_VERSION = require('../package.json').dependencies['@web5/api']; -const SDK_VERSIONS = require('../sdk-versions.json') +const SDK_VERSIONS = require('../sdk-versions.json'); const algoliaApiKey = process.env.DOC_SEARCH_API_KEY; const algoliaIndexName = process.env.DOC_SEARCH_INDEX_NAME; const algoliaAppId = process.env.DOC_SEARCH_APP_ID; +const inkeepApiKey = process.env.INKEEP_API_KEY; +const inkeepIntegrationId = process.env.INKEEP_INTEGRATION_ID; +const inkeepOrgId = process.env.INKEEP_ORG_ID; const feedbackWidgetApiUrl = process.env.FEEDBACK_WIDGET_API_URL; @@ -36,9 +39,13 @@ let config = { onBrokenMarkdownLinks: 'warn', favicon: '/img/favicon.ico', markdown: { - mermaid: true + mermaid: true, }, - themes: ['@docusaurus/theme-mermaid'], + themes: [ + '@docusaurus/theme-mermaid', + '@inkeep/docusaurus/chatButton', + '@inkeep/docusaurus/searchBar', + ], // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want // to replace "en" with "zh-Hans". @@ -53,7 +60,7 @@ let config = { }, plugins: [ 'docusaurus-tailwindcss', - require.resolve("./webpackPlugin"), + require.resolve('./webpackPlugin'), // [ // '@docusaurus/plugin-content-docs', // { @@ -183,10 +190,10 @@ let config = { label: 'Docs', position: 'left', }, - { - to: '#ask', - label: 'Ask 🤖', - }, + // { + // to: '#ask', + // label: 'Ask 🤖', + // }, // { // to: 'https://tbd.website', // position: 'right', @@ -253,7 +260,64 @@ let config = { }, ], }, - additionalLanguages: ['kotlin', 'swift', 'dart', 'rust', 'bash', 'gradle'], + additionalLanguages: [ + 'kotlin', + 'swift', + 'dart', + 'rust', + 'bash', + 'gradle', + ], + }, + inkeepConfig: { + baseSettings: { + apiKey: inkeepApiKey, + integrationId: inkeepIntegrationId, + organizationId: inkeepOrgId, + primaryBrandColor: '#FFEC19', + }, + aiChatSettings: { + chatSubjectName: 'Square', + botAvatarSrcUrl: + 'https://storage.googleapis.com/organization-image-assets/block-botAvatarSrcUrl-1712259107250.png', + botAvatarDarkSrcUrl: + 'https://storage.googleapis.com/organization-image-assets/block-botAvatarDarkSrcUrl-1712259106540.png', + quickQuestions: [ + 'How do I cancel a subscription via API?', + 'How do I add Square as a payment method to my iOS app?', + 'How do I show a buyer past transactions?', + ], + getHelpCallToActions: [ + { + url: 'https://squareup.com/us/en/l/developers/contact', + name: 'Support Center', + icon: { + builtIn: 'IoHelpBuoyOutline', + }, + }, + { + url: 'https://developer.squareup.com/forums', + name: 'Forums', + icon: { + builtIn: 'IoPeopleOutline', + }, + }, + { + url: 'https://discord.gg/squaredev', + name: 'Discord', + icon: { + builtIn: 'FaDiscord', + }, + }, + { + url: 'https://squareup.com/help', + name: 'Developer and App Marketplace Support', + icon: { + builtIn: 'IoChatbubblesOutline', + }, + }, + ], + }, }, }), }; diff --git a/site/package.json b/site/package.json index d36340c66..eca7c5480 100644 --- a/site/package.json +++ b/site/package.json @@ -20,6 +20,7 @@ "@docusaurus/theme-common": "3.1.1", "@docusaurus/types": "3.1.1", "@docusaurus/utils": "3.1.1", + "@inkeep/docusaurus": "^1.0.20", "@mdx-js/react": "3.0.1", "@react-aria/ssr": "3.6.0", "@react-aria/tooltip": "3.2.0",