diff --git a/fern/apis/fai/openapi.json b/fern/apis/fai/openapi.json index 7b7df4a9f..d03d0b2e5 100644 --- a/fern/apis/fai/openapi.json +++ b/fern/apis/fai/openapi.json @@ -1104,78 +1104,6 @@ ] } }, - "/discord/install": { - "post": { - "tags": [ - "Discord" - ], - "summary": "Create Discord Integration", - "operationId": "create_discord_integration", - "parameters": [ - { - "name": "domain", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Domain" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DiscordIntegrationResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - }, - "x-fern-audiences": [ - "customers" - ], - "security": [ - { - "bearerAuth": [] - } - ] - } - }, - "/discord/install/callback": { - "get": { - "tags": [ - "Discord" - ], - "summary": "Handle Discord Install Callback", - "operationId": "handle_discord_install_callback", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } - } - }, - "x-fern-audiences": [ - "internal" - ] - } - }, "/document/{domain}/create": { "post": { "tags": [ @@ -3169,52 +3097,6 @@ ] } }, - "/settings/ask-ai/discord": { - "get": { - "tags": [ - "Settings" - ], - "summary": "Get Discord Settings", - "description": "Get settings for a domain and organization.", - "operationId": "get_discord_settings", - "parameters": [ - { - "name": "domain", - "in": "query", - "required": true, - "schema": { - "type": "string", - "title": "Domain" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSettingsResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - }, - "x-fern-audiences": [ - "internal" - ] - } - }, "/settings/ask-ai/enable": { "post": { "tags": [ @@ -3266,7 +3148,7 @@ "Settings" ], "summary": "Toggle Ask Ai", - "description": "Toggle Ask AI setting and return job_id for tracking.\n\nArgs:\n domain: Domain to toggle Ask AI for\n org_name: Organization name\n preview: Whether this is a preview deployment\n locations: Optional list of locations to enable. Valid values: docs, slack, discord", + "description": "Toggle Ask AI setting and return job_id for tracking.\n\nArgs:\n domain: Domain to toggle Ask AI for\n org_name: Organization name\n preview: Whether this is a preview deployment\n locations: Optional list of locations to enable. Valid values: docs, slack", "operationId": "toggle_ask_ai", "parameters": [ { @@ -3308,8 +3190,7 @@ "items": { "enum": [ "docs", - "slack", - "discord" + "slack" ], "type": "string" } @@ -5480,19 +5361,6 @@ ], "title": "DeleteWebsiteResponse" }, - "DiscordIntegrationResponse": { - "properties": { - "integration_url": { - "type": "string", - "title": "Integration Url" - } - }, - "type": "object", - "required": [ - "integration_url" - ], - "title": "DiscordIntegrationResponse" - }, "Document": { "properties": { "document_id": { @@ -5623,7 +5491,7 @@ }, "type": "array", "title": "Locations", - "description": "List of locations to enable (docs, slack, discord)" + "description": "List of locations to enable (docs, slack)" }, "preview": { "type": "boolean", @@ -5996,7 +5864,7 @@ "ask_ai_enabled": { "type": "boolean", "title": "Ask Ai Enabled", - "description": "Whether Ask AI is enabled (requires one of docs, slack, or discord to be enabled as well as the content to be indexed)" + "description": "Whether Ask AI is enabled (requires one of docs or slack to be enabled as well as the content to be indexed)" }, "job_id": { "anyOf": [ @@ -6034,18 +5902,6 @@ "title": "Slack Enabled", "description": "Whether Ask AI is enabled for slack" }, - "discord_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Discord Enabled", - "description": "Whether Ask AI is enabled for discord" - }, "decompose_queries": { "anyOf": [ { diff --git a/fern/docs.yml b/fern/docs.yml index e48fd09c6..07cc63a0a 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -812,6 +812,10 @@ redirects: - source: /learn/api/api-reference/:slug* destination: /learn/cli-api-reference/cli-reference/overview + # Discord bot redirect (removed) + - source: /learn/docs/ai-features/ask-fern/discord-bot + destination: /learn/docs/ai-features/ask-fern/overview + # Ask Fern redirects (additional) - source: /learn/ask-fern/features/custom-fa-qs destination: /learn/docs/ai-features/ask-fern/overview diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 161333fb4..03ceac5d8 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -193,9 +193,6 @@ navigation: - page: Slack app path: ./pages/ask-fern/slack-app.mdx slug: slack-app - - page: Discord bot - path: ./pages/ask-fern/discord-bot.mdx - slug: discord-bot - page: Custom guidance path: ./pages/ask-fern/guidance.mdx slug: guidance @@ -431,8 +428,6 @@ navigation: hidden: true - conversation: hidden: true - - discord: - hidden: true - document: hidden: true - feedback: diff --git a/fern/products/docs/pages/ai/overview.mdx b/fern/products/docs/pages/ai/overview.mdx index 7561eb956..f07079dfa 100644 --- a/fern/products/docs/pages/ai/overview.mdx +++ b/fern/products/docs/pages/ai/overview.mdx @@ -21,12 +21,11 @@ Your documentation site comes with automatic optimizations for AI tools, plus fe ## Find answers -Users can chat with Ask Fern to get instant answers from your documentation. It's available as an embedded chat widget, via the [API](/learn/docs/ai-features/ask-fern/api-reference/overview) for custom integrations, and as a [Slack app](/learn/docs/ai-features/ask-fern/slack-app) or [Discord bot](/learn/docs/ai-features/ask-fern/discord-bot) for your community workspace. Ask Fern understands context and provides citations so users can verify information and explore further. +Users can chat with Ask Fern to get instant answers from your documentation. It's available as an embedded chat widget, via the [API](/learn/docs/ai-features/ask-fern/api-reference/overview) for custom integrations, and as a [Slack app](/learn/docs/ai-features/ask-fern/slack-app) for your community workspace. Ask Fern understands context and provides citations so users can verify information and explore further. - + - diff --git a/fern/products/docs/pages/ask-fern/assets/allow-discord-permissions.png b/fern/products/docs/pages/ask-fern/assets/allow-discord-permissions.png deleted file mode 100644 index 58e0537d5..000000000 Binary files a/fern/products/docs/pages/ask-fern/assets/allow-discord-permissions.png and /dev/null differ diff --git a/fern/products/docs/pages/ask-fern/assets/allow-discord.png b/fern/products/docs/pages/ask-fern/assets/allow-discord.png deleted file mode 100644 index 91afc7089..000000000 Binary files a/fern/products/docs/pages/ask-fern/assets/allow-discord.png and /dev/null differ diff --git a/fern/products/docs/pages/ask-fern/assets/config-saved-discord.png b/fern/products/docs/pages/ask-fern/assets/config-saved-discord.png deleted file mode 100644 index bc109e8f3..000000000 Binary files a/fern/products/docs/pages/ask-fern/assets/config-saved-discord.png and /dev/null differ diff --git a/fern/products/docs/pages/ask-fern/assets/members-list-discord.png b/fern/products/docs/pages/ask-fern/assets/members-list-discord.png deleted file mode 100644 index a3e683937..000000000 Binary files a/fern/products/docs/pages/ask-fern/assets/members-list-discord.png and /dev/null differ diff --git a/fern/products/docs/pages/ask-fern/assets/set-config-discord.png b/fern/products/docs/pages/ask-fern/assets/set-config-discord.png deleted file mode 100644 index 5909e9ff3..000000000 Binary files a/fern/products/docs/pages/ask-fern/assets/set-config-discord.png and /dev/null differ diff --git a/fern/products/docs/pages/ask-fern/discord-bot.mdx b/fern/products/docs/pages/ask-fern/discord-bot.mdx deleted file mode 100644 index b359f33fc..000000000 --- a/fern/products/docs/pages/ask-fern/discord-bot.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Ask Fern Discord bot -description: Enable your customers to get instant answers to product questions directly in Discord using Ask Fern's AI-powered documentation bot. ---- - - - - - Ask Fern is also available for Slack. See the [Slack app documentation](/learn/docs/ai-features/ask-fern/slack-app) for setup instructions. - - -The Ask Fern Discord bot allows customers to ask questions about your products directly in Discord channels and receive AI-generated answers from your documentation database. - -Fern stores all questions and answers from Discord interactions for [analytics purposes](/learn/docs/ai-features/ask-fern/overview#analytics). - -## Setup - -Install the Ask Fern bot in your Discord server and configure it for your channels. - - - To install Ask Fern in your Discord server, you must have **Manage Server** permissions. This is set in **Server Settings > People > Roles**. - - - - - -Use the [API Explorer](/learn/docs/ai-features/ask-fern/api-reference/discord/create-discord-integration) to get a unique Discord installation link for your organization. - -You will need: -- Your [Fern token](/learn/cli-api-reference/cli-reference/commands#fern-token) -- Your domain without protocol or path (e.g., `website.com`, not `https://website.com/docs`) - -You can alternatively use this cURL request: -```bash -curl -X POST "https://fai.buildwithfern.com/discord/install?domain=" \ - -H "Authorization: Bearer " -``` - -Follow the URL returned in the `integration_url` response field. - - - -You'll be redirected to Discord to authorize the Ask Fern bot. Select the server where you want to add Ask Fern and click **Authorize**. - - Allow Ask Fern for Discord server - - - - -Once the bot is added to your server, use the `/configure` slash command in each channel where you want the bot to respond. Without this configuration, the bot won't respond to messages in that channel. - - Configure bot by channel in Discord - - - - -## Configuration - -Customize the bot's behavior to match your workflow needs. - -### Bot settings per channel - -Use the `/configure` slash command in any channel to adjust the settings. This opens an interactive menu where you can configure: - -| Setting | Description | -|---------|-------------| -| **Response mode** | Controls whether the bot responds only when directly mentioned with `@Ask Fern` (`mentions_only`) or automatically responds to questions while ignoring casual chat (`auto`). | -| **Help role** | Optionally select a role or user to tag when users click the "Ask for help" button on bot responses. | - -After selecting your preferences, click **Save Configuration** to apply the changes. - - Config set success message in Discord - -### Customize the bot name - -You can rename the bot to match your brand (example: "YourCompanyName Support"): - - - To rename your Bot, you must have **Change Nickname** permissions. This is set in Server **Settings > People > Roles** - - - - Go to the Members List section at the top of the Discord server - - Discord members list - - - - Right click the AskFern bot and select "Change Nickname" - - - Enter your preferred bot name and click "Save" - - -Now, users will see your custom bot name instead of the default "Ask Fern" name. - -## Architecture - -When a user asks Ask Fern a question in Discord, the bot receives the message and triggers Fern's servers to search your documentation database and retrieve relevant context. Using that context, Ask Fern generates a response and replies in a thread. - - -```mermaid -sequenceDiagram - autonumber - participant U as User (Discord) - participant D as Discord Bot - participant F as Fern Servers - participant V as Documentation Database - participant A as Ask Fern - - U->>D: Ask question to @Ask Fern - D->>F: Forward message to Fern servers - F->>F: Convert query to vector - F->>V: Search for relevant chunks - V->>F: Return matching documents - F->>A: Send query + context - A->>A: Generate response - A->>D: Return answer - D->>U: Reply in Discord thread - F->>F: Store question and answer for analytics -``` - diff --git a/fern/products/docs/pages/ask-fern/slack-app.mdx b/fern/products/docs/pages/ask-fern/slack-app.mdx index 6c1498fb0..4276f53f4 100644 --- a/fern/products/docs/pages/ask-fern/slack-app.mdx +++ b/fern/products/docs/pages/ask-fern/slack-app.mdx @@ -5,10 +5,6 @@ description: Enable your customers to get instant answers to product questions d - - Ask Fern is also available for Discord. See the [Discord bot documentation](/learn/docs/ai-features/ask-fern/discord-bot) for setup instructions. - - The Ask Fern Slack app allows customers to ask questions about your products directly in Slack channels and receive AI-generated answers from your documentation database. Fern stores all questions and answers from Slack interactions for [analytics purposes](/learn/docs/ai-features/ask-fern/overview#analytics). diff --git a/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx b/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx index 5d8692a51..88b3adc06 100644 --- a/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx +++ b/fern/products/docs/pages/ask-fern/what-is-ask-fern.mdx @@ -28,8 +28,8 @@ Ask Fern is Fern's AI Search feature, powered by **Retrieval Augmented Generatio Enabling Ask Fern triggers an automatic reindex of your content. This typically takes a few minutes, though sites with extensive custom components may take longer. Once this process is finished, the Ask Fern side panel will appear on your site. - - Connect Ask Fern to [Slack](/learn/docs/ai-features/ask-fern/slack-app) or [Discord](/learn/docs/ai-features/ask-fern/discord-bot) so your users can ask questions directly from chat. + + Connect Ask Fern to [Slack](/learn/docs/ai-features/ask-fern/slack-app) so your users can ask questions directly from chat. Finetune Ask Fern's behavior: diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx index b4c0c93a1..f857d34f2 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx @@ -58,12 +58,12 @@ Passing `request` as the selector will only render the request schema.
- +
```jsx Markdown - + ``` ### Request body