diff --git a/docs/english/concepts/adding-agent-features.md b/docs/english/concepts/adding-agent-features.md index dc28a065d..3f449e4a2 100644 --- a/docs/english/concepts/adding-agent-features.md +++ b/docs/english/concepts/adding-agent-features.md @@ -10,7 +10,7 @@ The code snippets throughout this guide are from our [Support Agent sample app]( View our [agent quickstart](/ai/agent-quickstart) to get up and running with Casey. Otherwise, read on for exploration and explanation of agent-focused Bolt features found within Casey. ::: -Your agent can utilize features applicable to messages throughout Slack, like [chat streaming](#text-streaming) and [feedback buttons](#adding-and-handling-feedback). They can also [utilize the `Assistant` class](/tools/bolt-js/concepts/assistant-class) for a side-panel view designed with AI in mind. +Your agent can utilize features applicable to messages throughout Slack, like [chat streaming](#text-streaming) and [feedback buttons](#adding-and-handling-feedback). They can also [utilize the `Assistant` class](/tools/bolt-js/concepts/using-the-assistant-class) for a side-panel view designed with AI in mind. If you're unfamiliar with using these feature within Slack, you may want to read the [API docs on the subject](/ai/). Then come back here to implement them with Bolt! diff --git a/docs/english/concepts/message-sending.md b/docs/english/concepts/message-sending.md index ec59c1454..f851e08b7 100644 --- a/docs/english/concepts/message-sending.md +++ b/docs/english/concepts/message-sending.md @@ -120,4 +120,4 @@ const feedbackBlock = { }; ``` -Read more about streaming messages in the [_Adding agent features_](/tools/bolt-js/adding-agent-features) guide. +Read more about streaming messages in the [_Adding agent features_](/tools/bolt-js/concepts/adding-agent-features) guide. diff --git a/docs/english/creating-an-app.md b/docs/english/creating-an-app.md index e8c41e874..93a468c75 100644 --- a/docs/english/creating-an-app.md +++ b/docs/english/creating-an-app.md @@ -168,7 +168,7 @@ The above example works on Linux and macOS, but [similar commands are available :::danger[Keep your tokens and signing secret secure] -At a minimum, you should avoid checking tokens and signing secrets into public version control, and you should access them via environment variables as shown above. Check out the guide to [app security best practices](/security) for more insights. +At a minimum, you should avoid checking tokens and signing secrets into public version control, and you should access them via environment variables as shown above. Check out the guide to [app security best practices](/concepts/security) for more insights. ::: diff --git a/docs/english/deployments/aws-lambda.md b/docs/english/deployments/aws-lambda.md index 34b6e9733..316fd8f35 100644 --- a/docs/english/deployments/aws-lambda.md +++ b/docs/english/deployments/aws-lambda.md @@ -235,7 +235,7 @@ ngrok http 3000 :::info -[Learn how to use ngrok](/tools/bolt-js/building-an-app#preparing-receive-events) to create a public URL and forward requests to your local machine. +[Learn how to use ngrok](/tools/bolt-js/creating-an-app/#preparing-receive-events) to create a public URL and forward requests to your local machine. ::: diff --git a/docs/english/deployments/heroku.md b/docs/english/deployments/heroku.md index a21d8cccf..0ff553ea8 100644 --- a/docs/english/deployments/heroku.md +++ b/docs/english/deployments/heroku.md @@ -184,7 +184,7 @@ heroku config:set SLACK_BOT_TOKEN=xoxb- :::info -If you don't know where to find your credentials, please read about [exporting your signing secret and token](/tools/bolt-js/building-an-app#preparing-receive-events) in the Building an app guide. +If you don't know where to find your credentials, please read about [exporting your signing secret and token](/tools/bolt-js/creating-an-app/#preparing-receive-events) in the Building an app guide. ::: diff --git a/docs/english/deployments/vercel/index.md b/docs/english/deployments/vercel/index.md index 9d1241927..f721fcda1 100644 --- a/docs/english/deployments/vercel/index.md +++ b/docs/english/deployments/vercel/index.md @@ -95,4 +95,4 @@ Your app is now set up to build and deploy whenever you commit to your repo. ✨ Explore Vercel documentation [here](https://vercel.com/docs/git). -✨ Learn all about [developing apps with AI features](/ai/developing-ai-apps). \ No newline at end of file +✨ Learn all about [developing apps with AI features](/ai/developing-agents). \ No newline at end of file diff --git a/docs/english/getting-started.md b/docs/english/getting-started.md index d0a8da15d..b3d8933ee 100644 --- a/docs/english/getting-started.md +++ b/docs/english/getting-started.md @@ -9,7 +9,7 @@ When complete, you'll have a local environment configured with a customized [app :::tip[Reference for readers] -In search of the complete guide to building an app from scratch? Check out the [building an app](/tools/bolt-js/building-an-app) guide. +In search of the complete guide to building an app from scratch? Check out the [building an app](/tools/bolt-js/creating-an-app) guide. ::: @@ -147,7 +147,7 @@ The above command works on Linux and macOS but [similar commands are available o :::warning[Keep it secret. Keep it safe] -Treat your tokens like a password and [keep it safe](/security). Your app uses these to retrieve and send information to Slack. +Treat your tokens like a password and [keep it safe](/concepts/security). Your app uses these to retrieve and send information to Slack. ::: diff --git a/docs/english/legacy/hubot-migration.md b/docs/english/legacy/hubot-migration.md index 00c5da876..b2ea759db 100644 --- a/docs/english/legacy/hubot-migration.md +++ b/docs/english/legacy/hubot-migration.md @@ -47,14 +47,14 @@ The [Events API](/legacy/legacy-bot-users#handling-events) is a bot's equivalent :::info -Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/tools/bolt-js/building-an-app) and [setting up events](/tools/bolt-js/building-an-app#preparing-receive-events) in the Getting Started guide. +Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/tools/bolt-js/creating-an-app) and [setting up events](/tools/bolt-js/creating-an-app/#preparing-receive-events) in the Getting Started guide. ::: ### Listening for messages All Hubot apps can listen to messages by default, so we need to configure your bot user to do the same. -After walking through [setting up events](/tools/bolt-js/building-an-app#preparing-receive-events), your Request URL should be verified. Scroll down to **Subscribe to Bot Events**. There are four events related to messages: `message.channels` (listens for messages in public channels), `message.groups` (listens for messages in private channels), `message.im` (listens for messages in the App Home/DM space), and `message.mpim` (listens for messages in multi-person DMs). +After walking through [setting up events](/tools/bolt-js/creating-an-app/#preparing-receive-events), your Request URL should be verified. Scroll down to **Subscribe to Bot Events**. There are four events related to messages: `message.channels` (listens for messages in public channels), `message.groups` (listens for messages in private channels), `message.im` (listens for messages in the App Home/DM space), and `message.mpim` (listens for messages in multi-person DMs). If you only want your bot to listen to messages in channels, you can listen to `message.channels` and `message.groups`. Or if you want your bot to listen to messages from everywhere it is, choose all four message events. diff --git a/docs/english/reference.md b/docs/english/reference.md index 01f51fe64..b9765081f 100644 --- a/docs/english/reference.md +++ b/docs/english/reference.md @@ -4,7 +4,7 @@ sidebar_label: Reference # Bolt for JavaScript interface and configuration reference -This guide is intended to detail the Bolt interface–including listeners and their arguments, initialization options, and errors. It may be helpful to first go through the ⚡️[Building an app guide](/tools/bolt-js/building-an-app) to learn the basics of building Bolt for JavaScript apps. +This guide is intended to detail the Bolt interface–including listeners and their arguments, initialization options, and errors. It may be helpful to first go through the ⚡️[Building an app guide](/tools/bolt-js/creating-an-app) to learn the basics of building Bolt for JavaScript apps. --- diff --git a/docs/english/tutorials/ai-assistant.md b/docs/english/tutorials/ai-assistant.md index 01f23a373..f76972ba9 100644 --- a/docs/english/tutorials/ai-assistant.md +++ b/docs/english/tutorials/ai-assistant.md @@ -459,7 +459,7 @@ After getting the thread replies, we map them to the appropriate object structur } ``` -The entirety of the user message processing in this example is wrapped in a try-catch block to provide the user an error message when something goes wrong, which is a best practice. If successful, the final action we take is to call the `say` method with the LLM response. This sample also shows how to implement [text streaming](/ai/developing-ai-apps#streaming) in code. Omitting the `streamer` would result in the app responding with one block of text, versus providing chunks at a time. +The entirety of the user message processing in this example is wrapped in a try-catch block to provide the user an error message when something goes wrong, which is a best practice. If successful, the final action we take is to call the `say` method with the LLM response. This sample also shows how to implement [text streaming](/ai/developing-agents#streaming) in code. Omitting the `streamer` would result in the app responding with one block of text, versus providing chunks at a time. #### Using the markdown block in `say` {#markdown-block} @@ -492,7 +492,7 @@ This sample app uses Socket Mode to receive events. This is great for developing ➡️ Read more about Bolt support for apps using platform AI features in the documentation [here](/tools/bolt-js/concepts/adding-agent-features). -➡️ Level up your AI game after reading through the [usage guide](/ai/developing-ai-apps) and [Best practices for AI feature-enabled apps](/ai/ai-apps-best-practices). +➡️ Level up your AI game after reading through the [usage guide](/ai/developing-agents) and [Best practices for AI feature-enabled apps](/ai/developing-agents/). ### Explore pre-built apps using AI features {#marketplace} diff --git a/docs/english/tutorials/code-assistant.md b/docs/english/tutorials/code-assistant.md index 7974dfd48..160682076 100644 --- a/docs/english/tutorials/code-assistant.md +++ b/docs/english/tutorials/code-assistant.md @@ -1,6 +1,6 @@ # AI Code Assistant with Hugging Face -In this tutorial, we will create an [app that has platform AI features enabled](/ai/developing-ai-apps) with the Bolt framework and integrate a [Hugging Face](https://huggingface.co) model to assist the user with coding questions. We'll also make this functionality available as a step in a workflow to use in Workflow Builder. +In this tutorial, we will create an [app that has platform AI features enabled](/ai/developing-agents) with the Bolt framework and integrate a [Hugging Face](https://huggingface.co) model to assist the user with coding questions. We'll also make this functionality available as a step in a workflow to use in Workflow Builder. Hugging Face is an open-source community best known for its transformers library and platform for machine learning models. Hugging Face's model hub is an online repository where you can find thousands of pre-trained models for natural language processing, computer vision, speech recognition, and more. The platform is open-source, so anyone can contribute to the models and browse the models others have started. Here, we will be using the [Qwen2.5-Coder-32B-Instruct](https://huggingface.co/Qwen/Qwen2.5-Coder-32B-Instruct) model to create an app that can answer coding questions. diff --git a/docs/english/tutorials/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md b/docs/english/tutorials/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md index 78fea7d3d..0c9977cf9 100644 --- a/docs/english/tutorials/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md +++ b/docs/english/tutorials/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md @@ -68,7 +68,7 @@ All of your app's settings can be configured within these screens. By creating a Navigate to **Event Subscriptions** and expand **Subscribe to bot events** to see that we have subscribed to the `function_executed` event. This is also a requirement for adding workflow steps to our app, as it lets our app know when a step has been triggered, allowing our app to respond to it. -Another configuration setting to note is **Socket Mode**. We have turned this on for our local development, but socket mode is not intended for use in a production environment. When you are satisfied with your app and ready to deploy it to a production environment, you should switch to using public HTTP request URLs. Read more about getting started with HTTP in [Bolt for JavaScript here](/tools/bolt-js/building-an-app). +Another configuration setting to note is **Socket Mode**. We have turned this on for our local development, but socket mode is not intended for use in a production environment. When you are satisfied with your app and ready to deploy it to a production environment, you should switch to using public HTTP request URLs. Read more about getting started with HTTP in [Bolt for JavaScript here](/tools/bolt-js/creating-an-app). Clicking on **Workflow Steps** in the left nav will show you that one workflow step has been added! This reflects the `function` defined in our manifest: functions are workflow steps. We will get to this step's implementation later. diff --git a/docs/japanese/creating-an-app.md b/docs/japanese/creating-an-app.md index 797b1c7a9..b23f6d69e 100644 --- a/docs/japanese/creating-an-app.md +++ b/docs/japanese/creating-an-app.md @@ -51,7 +51,7 @@ Slack アプリで使用できるトークンには、ユーザートークン :::tip -トークンは、パスワードのように大切に扱い、[安全に保管](/security)してください。アプリではそのトークンを使用して、Slack ワークスペースからの情報を投稿および取得します。 +トークンは、パスワードのように大切に扱い、[安全に保管](/concepts/security)してください。アプリではそのトークンを使用して、Slack ワークスペースからの情報を投稿および取得します。 ::: @@ -87,7 +87,7 @@ export SLACK_BOT_TOKEN=xoxb- :::info -🔒 全てのトークンは安全に保管してください。少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](/security)のドキュメントを参照してください。 +🔒 全てのトークンは安全に保管してください。少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](/concepts/security)のドキュメントを参照してください。 :::