Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions ai/writer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Writer"
description: "AI-powered documentation assistant that creates and updates docs from Slack threads and web content"
icon: "pen-tool"
---

<Info>
Writer is currently in testing phase. Try it out in the designated testing channel for feedback and bug reports.
</Info>

Writer is an AI-powered documentation assistant that helps you create and maintain technical documentation directly from Slack conversations and web content. It can read Slack thread links, fetch content from web pages, and perform web searches to generate comprehensive documentation.

## Key features

Writer provides several powerful capabilities for documentation creation:

**Slack thread integration**
- Reads and processes Slack thread links to extract relevant information
- Must be added to the channel you're linking from to access thread content
- Converts conversation context into structured documentation

**Web content fetching**
- Fetches content from any publicly accessible web page
- Processes HTML content and converts it to documentation format
- Useful for incorporating external resources and references

**Web search capabilities**
- Performs general web searches similar to AI assistant functionality
- Gathers up-to-date information for documentation accuracy
- Helps research topics and verify technical details

## Using Writer

To use Writer in your Slack workspace:

1. **Mention the bot**: Use `@MintlifyWriter` in channels where it has been added
2. **Provide context**: Share Slack thread links, web URLs, or describe what documentation you need
3. **Review output**: Writer will create or update documentation based on your request
4. **Provide feedback**: Report any issues or suggestions in the testing channel

## Current limitations

Writer is in active development with the following known limitations:

- Cannot re-edit previous pull requests when mentioned again
- Makes separate commits for each file update, which can be repetitive
- Requires manual review for technical accuracy
- Only works with publicly accessible web content for fetching

## Testing and feedback

Writer is available for testing with feedback encouraged. When testing:

- Try different types of content sources (Slack threads, web pages, search queries)
- Report any bugs or unexpected behavior
- Provide suggestions for feature improvements
- Test edge cases and complex documentation scenarios

The development team actively monitors for bugs and welcomes feedback to improve Writer's capabilities and reliability.
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
"guides/claude-code",
"guides/cursor",
"guides/windsurf",
"ai/slack-app"
"ai/slack-app",
"ai/writer"
]
},
{
Expand Down