Overview
Slab is a knowledge management platform that helps teams create, organize, and share documentation. The Shortcut integration connects your knowledge base with development work, ensuring documentation stays current with product changes.
Key Features
- Link Previews: Shortcut links unfurl with Story details in Slab
- Documentation Linking: Connect specs and docs to Stories
- Search Integration: Find related Stories from Slab search
- Embed Stories: Display Story status in documentation
- Two-Way References: Navigate between docs and Stories
Setting Up the Integration
- In Slab, go to Settings > Integrations
- Find Shortcut and click Connect
- Authorize Slab to access your Shortcut workspace
- Configure link preview preferences
Using the Integration
Link Previews
When you paste a Shortcut link in Slab:
- Story name and description appear
- Current workflow state is shown
- Owner and Team are displayed
- Click to open the Story directly
Embedding Stories
Include live Story information in your documentation:
- Paste a Shortcut Story URL
- The link automatically unfurls
- Status updates reflect in real-time
Connecting Documentation to Stories
Reference Slab articles in Shortcut Stories:
- Copy the Slab article URL
- Paste in the Story description or comments
- Team members can quickly access relevant docs
Best Practices
- Link specs to Stories: Connect technical specifications to implementation work
- Update docs when shipping: Add Story links to changelog documentation
- Reference in PRs: Include both Slab docs and Stories in code reviews
- Maintain living docs: Keep documentation current with development progress