Docs, for Moxie Docs

Share changelog to Slack

2 min readUpdated

Overview

Connect Slack to Moxie Docs so your team sees what changed in your docs without leaving chat. After setup, Moxie Docs will post weekly recaps of documentation updates and announce new doc pull requests created from drift findings to a Slack channel when they’re available.

Before you start

  • A Moxie Docs account with access to the dashboard
  • Your GitHub repository already connected to Moxie Docs
  • A Slack workspace where you can approve apps and post to a channel
  • Permission to choose or create a channel for updates

Connect

  1. Open the Moxie Docs dashboard and go to the area where you manage integrations or chat connections. If you do not see Slack, open your account or workspace settings and look for integrations.
  2. Select Slack and start the connection. This opens Slack’s authorization screen in your browser.
  3. In Slack, review the requested permissions and choose the Slack workspace.
  4. Click Allow to approve the connection and return to Moxie Docs.
  5. Back in Moxie Docs, confirm the Slack channel you want to use for updates. If prompted, pick a public or private channel you have access to.

Note: If your Slack admin requires approval, Slack may route the request to an admin before the connection completes.

Configure

After connecting, set where and what Moxie Docs should post:

  • Channel: Select the Slack channel that should receive updates.
  • Weekly recap: Enable posting a weekly summary of documentation changes when a recap is available.
  • New doc pull requests: Enable posting an announcement when Moxie Docs creates a PR to update outdated docs.
  • Repository scope: If you manage multiple repos in Moxie Docs, choose which connected repositories should send updates to Slack.

Verify it works

  • Post test: In the Slack configuration area, send a test message and confirm it appears in the selected channel.
  • Weekly recap check: After the next weekly cycle, confirm a recap message appears in the channel when there are changes to share.
  • PR announcement check: Create or approve a doc PR from a drift finding in Moxie Docs and confirm an announcement posts in the channel.
  • Connection status: In the Moxie Docs Slack settings, confirm the connection shows as connected to the correct workspace and channel.

Disconnect or change access

  • To change the channel or what gets posted, open the Slack settings in Moxie Docs and update the channel and options.
  • To remove Slack from Moxie Docs, open the Slack connection in Moxie Docs and disconnect it. Then, in Slack, open the workspace app management page and remove the Moxie Docs app if you no longer want it available.
  • If your Slack workspace or channel permissions change, reconnect Slack from Moxie Docs to refresh access.

Was this page helpful?

Let us know if you found what you were looking for.

Related articles

GuidesAdmin blog via SnowSEO webhookConnect SnowSEO to your Moxie Docs admin blog so new articles sent by SnowSEO arrive as dr
GuidesBilling, trial, or access issuesThis guide helps you resolve common issues starting a trial, updating payment details, and
GuidesConfigure PR automation and detectorsThis guide helps you tune how Moxie Docs surfaces documentation drift and how those findin