diff --git a/fern/docs/index.mdx b/fern/docs/index.mdx index 23051fa..3375328 100644 --- a/fern/docs/index.mdx +++ b/fern/docs/index.mdx @@ -7,62 +7,212 @@ description: Automated docs that eliminate manual overhead and keep your docs cu All content on this docs site was generated by Promptless. See how in our public docs repo. -Promptless automatically generates and updates docs based on your existing product and development workflows. No more undocumented new features, or out-of-date docs that confuse your customers—just fresh, accurate docs that evolve with your product effortlessly. +Promptless automatically generates and updates documentation based on your existing product and development workflows. Choose from multiple interaction methods to fit your team's preferences—from automated pull request triggers to on-demand Slack mentions. No more undocumented features or outdated docs that confuse your customers. + +## Ways to Use Promptless + +Use Promptless in the way that best fits your team's workflow—automated, on-demand, or through a web interface. - - Eliminate docs debt by automatically catching when code changes require doc updates, without disrupting your development workflow. + + Automatically trigger documentation updates when pull requests are opened or updated. + + **Setup effort:** Low + + + + Mention @Promptless in channels or use message actions to update docs on demand. + + **Setup effort:** Low + + + + Review, edit, and provide feedback on documentation suggestions in a visual editor. + + **Setup effort:** None (after integrations) + + + + Trigger documentation updates directly from Microsoft Teams conversations. + + **Setup effort:** Low + + + +## Build Your Documentation Workflow + +Promptless operates through three interconnected components. Configure each to match your team's needs and tools. + +### Choose Your Triggers + +Triggers monitor your development ecosystem for events that indicate documentation needs. + + + + Automatic triggers from pull requests and code changes + + + + On-demand triggers from team discussions and mentions + + + + Manual triggers from Teams conversations + + + + Automatic triggers from Bitbucket pull requests + + + + Automatic triggers from GitLab merge requests - - Focus on information architecture and strategy while Promptless handles the routine updates and maintenance of your docs. + + Triggers from support ticket patterns -## How Promptless Works +### Add Context Sources + +Enrich documentation with real-time access to your organization's knowledge. + + + + Project management context and feature requirements + + + + Issue tracking and project context + + + + Repository analysis and code understanding + + + + Team conversations and decisions + + + + Document context and file storage + + + + Repository and code context + + + +### Select Publishing Destinations + +Distribute updates across your entire documentation ecosystem. + + + + Fern, Mintlify, GitBook, Docusaurus, MkDocs, Hugo, and more + + + + Direct API integration for ReadMe platform + + + + Zendesk Help Center, Intercom (Beta) + + + + Webflow CMS (Beta), Notion databases (Beta) + + -Promptless operates through three interconnected components that work together to understand your codebase, gather context, and publish updates automatically. +## Compare Features by Integration Method -```mermaid -graph LR - TRIGGERS["GitHub PR, Slack message,
Support ticket"] - CONTEXT["Linear, Jira, GitHub,
Slack, Google Drive"] - DOCS["Git-hosted docs, ReadMe,
Help Center"] +See how different ways of using Promptless support various features and workflows. + +| | **GitHub PR** | **Slack** | **MS Teams** | **Web Interface** | +| --- | --- | --- | --- | --- | +| **Setup** | OAuth connection | OAuth connection | Admin installation | Access via dashboard | +| **Trigger Type** | Automatic | On-demand | On-demand | Review only | +| **Context Awareness** | Full PR context + all comments | Full thread context + images | Message context | All available context | +| **Follow-up Instructions** | Tag @Promptless in comments | Tag @Promptless in thread | Tag @Promptless | Add comments in editor | +| **Image Support** | ✓ | ✓ | Limited | ✓ | +| **PDF Processing** | ✓ | ✓ (enhanced) | ✓ | — | +| **Multi-file Changes** | ✓ | ✓ | ✓ | ✓ | +| **Visual Diff Review** | GitHub UI | — | — | ✓ | +| **Inline Editing** | — | — | — | ✓ | + +## Compare Integration Patterns + +Different teams use Promptless in different ways. Here are the most common patterns. + +### By Team Size + + + + **Recommended Setup:** + - Trigger: GitHub PRs + - Context: GitHub only + - Publishing: Single git-hosted docs platform + + **Why it works:** Minimal configuration overhead while automating the most common documentation updates. + + + + **Recommended Setup:** + - Triggers: GitHub PRs + Slack + - Context: GitHub + Linear/Jira + Slack + - Publishing: Git-hosted docs + Help Center - TRIGGERS --> PROMPTLESS - PROMPTLESS["Promptless"] - CONTEXT -.-> PROMPTLESS - PROMPTLESS --> DOCS + **Why it works:** Balances automation with on-demand control, while enriching context from multiple sources. + + + + **Recommended Setup:** + - Triggers: GitHub PRs + Slack + Zendesk + - Context: All available sources + - Publishing: Multiple platforms simultaneously - style TRIGGERS fill:#dbeafe,stroke:#3b82f6,stroke-width:2px - style CONTEXT fill:#ede9fe,stroke:#8b5cf6,stroke-width:2px - style DOCS fill:#d1fae5,stroke:#10b981,stroke-width:2px - style PROMPTLESS fill:#8b5cf6,stroke:#6d28d9,stroke-width:3px,color:#fff -``` + **Why it works:** Comprehensive automation across all documentation touchpoints with maximum context enrichment. + + + +### By Use Case - - - Monitor your development ecosystem for events that indicate documentation needs—from pull requests and code changes to team discussions and support tickets. + + + **GitHub + Slack** → Git-hosted docs + + PR triggers with team discussion context. Ideal for teams with strong Slack culture. - - Enrich docs with real-time access to your organization's knowledge through integrations with project management tools, code repositories, and team communications. + + **Zendesk + Jira** → Help Center + + Monitor resolved tickets for documentation gaps. Context from support conversations. - - Distribute updates across your entire docs ecosystem—from GitHub-synced platforms to help centers and content management systems. + + **Linear + GitHub + Slack** → Multi-platform + + Connect project management with technical accuracy. Publish to multiple destinations. + + + + **GitHub + Web Interface** → Git-hosted docs + + Automated detection with manual review and editing before publishing. -## Key Benefits +## Key Capabilities - - Docs updates happen automatically when code changes, eliminating manual monitoring and reducing the risk of outdated information. + + Documentation updates happen automatically when code changes, eliminating manual monitoring and reducing the risk of outdated information. - - Deep integration with your existing tools means Promptless understands your organization's specific terminology, processes, and doc styles. + + Deep integration with your existing tools means Promptless understands your organization's specific terminology, processes, and documentation styles. @@ -74,43 +224,199 @@ graph LR -## Who Uses Promptless +## Component Examples -Promptless serves development teams and technical writers who need to maintain accurate, comprehensive docs without sacrificing development velocity. +This page shows the Fern components available in Promptless docs. Switch between Example and Markdown tabs to see the rendered output and source code. -### Development Teams -- **Reduce Context Switching**: Generate docs without leaving your existing workflows -- **Maintain Consistency**: Ensure docs stay aligned with actual implementation -- **Scale Documentation**: Support multiple projects without proportional overhead +### Cards -### Technical Writers -- **Eliminate Communication Friction**: Stay automatically in the loop for any doc-impacting PRs—no more relying on engineers to remember to inform the docs team -- **Reduce Documentation Backlog**: Connect all necessary context automatically and draft updates, so you don't have to chase down team members for information -- **Enforce Consistent Standards**: Automatically apply your style guides and documentation rules, ensuring quality without manual oversight +Group related links and information. - -Ready to get started? Promptless integrates with your existing tools and workflows to provide immediate value without disrupting your team's productivity. - + + + + + Connect your tools and start automating docs in under 10 minutes. + + + + Detailed setup instructions for GitHub, Slack, Linear, and more. + + + + + + ```jsx + + + Connect your tools and start automating docs in under 10 minutes. + + + + Detailed setup instructions for GitHub, Slack, Linear, and more. + + + ``` + + -## Popular Integration Patterns +### Callouts - - - The most common setup—trigger docs updates from pull requests and team discussions, publish to GitHub-synced docs platforms. - +Highlight important information with Info, Tip, and Warning callouts. + + + + + All content on this docs site was generated by Promptless. + + + + Enable auto-publish mode to automatically create PRs without manual review. + + + + Self-hosting requires Enterprise plan and custom engineering work. + + - - Connect project management workflows with customer-facing docs to ensure feature releases include updated help center content. - + + ```jsx + + All content on this docs site was generated by Promptless. + + + + Enable auto-publish mode to automatically create PRs without manual review. + + + + Self-hosting requires Enterprise plan and custom engineering work. + + ``` + + + +### Steps + +Multi-step processes with automatic numbering. + + + + + + Link your GitHub, Slack, and other tools via OAuth. + + + + Choose which events should trigger documentation updates. + + + + Promptless begins monitoring and suggesting documentation updates. + + + - - Use Linear issues for context while publishing docs updates across multiple platforms simultaneously. - + + ```jsx + + + Link your GitHub, Slack, and other tools via OAuth. + + + + Choose which events should trigger documentation updates. + + + + Promptless begins monitoring and suggesting documentation updates. + + + ``` + + + +### Accordions + +Collapsible sections for detailed information. + + + + + + Promptless supports automatic triggers from GitHub, Bitbucket, and GitLab pull requests, as well as on-demand triggers from Slack and Microsoft Teams mentions. + + + + Yes! Connect Linear, Jira, GitHub, Slack, and Google Drive simultaneously to enrich your documentation with comprehensive context. + + + + Promptless publishes to git-hosted platforms (Fern, Mintlify, GitBook, etc.), direct API integrations (ReadMe, Zendesk), and beta platforms (Webflow, Notion). + + + - - Monitor Zendesk tickets for documentation gaps and automatically update your help center content when features change or issues arise. - - + + ```jsx + + + Promptless supports automatic triggers from GitHub, Bitbucket, and GitLab pull requests, as well as on-demand triggers from Slack and Microsoft Teams mentions. + + + + Yes! Connect Linear, Jira, GitHub, Slack, and Google Drive simultaneously to enrich your documentation with comprehensive context. + + + + Promptless publishes to git-hosted platforms (Fern, Mintlify, GitBook, etc.), direct API integrations (ReadMe, Zendesk), and beta platforms (Webflow, Notion). + + + ``` + + + +## Who Uses Promptless + +Promptless automatically detects when code changes require documentation updates and notifies your team through your existing workflows. + +### Development Teams + +When you open a PR, Promptless automatically checks if docs need updating and notifies your team in Slack. + + + Slack notification from Promptless bot showing documentation updates detected + + +Promptless drafts the initial update based on your PR changes, so you can review and publish without switching between tools. + +### Technical Writers + +Promptless automatically detects doc-impacting PRs and sends notifications to your Slack channels, so you stay informed without monitoring a hundred release channels or attending every standup. + + + Promptless notification showing GitHub PR detected with documentation updates + + +When reviewing suggestions, all the context you need—PR details, related conversations, issue tickets—is available directly in the web interface. + + + Web interface showing citation panel with GitHub PR context and research details + + +## Compare Deployment Options + +Choose between cloud-hosted and self-hosted deployment based on your requirements. + +| | **Cloud-Hosted** | **Self-Hosted** | +| --- | --- | --- | +| **Setup Time** | < 10 minutes | 1-2 days | +| **Maintenance** | Fully managed | Self-managed | +| **Updates** | Automatic | Manual helm chart updates | +| **Data Location** | Promptless infrastructure | Your infrastructure | +| **Custom Authentication** | SSO via OAuth | Custom SAML/OIDC | +| **Air-Gapped Deployment** | ✗ | ✓ | +| **Pricing** | Standard pricing | Enterprise only | ## Next Steps