> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstar.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Automated product marketing for engineers and agents

## Welcome to Shipstar

Shipstar turns your GitHub commits into polished marketing content — changelogs, blog posts, social media threads, knowledge base articles, and more. Connect your repos, and Shipstar handles the rest.

### What You Can Build

<CardGroup cols={2}>
  <Card title="Public Changelogs" icon="list-check" href="/api-reference/overview">
    Auto-generate structured changelogs from your commits and publish them with a public URL and RSS feed
  </Card>

  <Card title="Blog Posts" icon="pen-nib" href="/api-reference/overview">
    Generate feature announcements, weekly updates, and SEO-optimized blog content
  </Card>

  <Card title="Social Media" icon="share-nodes" href="/api-reference/overview">
    Create LinkedIn posts and Twitter/X threads ready to publish
  </Card>

  <Card title="Knowledge Base" icon="book" href="/api-reference/overview">
    Produce categorized help articles from your feature work and publish them to Intercom or Featurebase
  </Card>
</CardGroup>

## Content Types

Shipstar generates 10 types of content from your commits:

| Content Type | Format | Use Case |
| - | - | - |
| Daily Product Update | Markdown | Daily internal update from the last 24 hours of changes |
| Weekly Product Update | Markdown | Weekly summary for non-technical stakeholders |
| Feature Blog | Markdown | SEO-optimized feature announcement |
| Blog Post | Markdown | General blog post |
| LinkedIn Post | Text | Professional social media post |
| Twitter Thread | Text | 3-5 tweet thread |
| Feature Page | JSON | Structured feature page for your marketing site |
| KB Articles | JSON | Categorized help center articles |
| Public Changelog | JSON | Structured changelog with entries |
| Release Notes Email | JSON | Email-formatted release notes |

## Getting Started

<Steps>
  <Step title="Create an Account">
    Sign up at [app.shipstar.ai](https://app.shipstar.ai) to create your account.
  </Step>

  <Step title="Connect GitHub">
    Install the Shipstar GitHub App on your organization and select the repositories you want to track.
  </Step>

  <Step title="Generate Content">
    Trigger content generation from the dashboard or via the API. Shipstar analyzes your recent commits and produces polished content.
  </Step>

  <Step title="Publish & Distribute">
    Publish content to public URLs with RSS feeds, or distribute to Slack, Intercom, and Featurebase directly.
  </Step>
</Steps>

## Key Features

<AccordionGroup>
  <Accordion title="AI-Powered Generation">
    Shipstar uses Claude to analyze your commits and produce content that focuses on what matters to your users — not implementation details.
  </Accordion>

  <Accordion title="Publish Anywhere">
    Every piece of content gets a public URL and RSS feed. You can also push directly to Slack, Intercom, and Featurebase.
  </Accordion>

  <Accordion title="Scheduled Content">
    Set up recurring calendar events to automatically generate and publish changelogs, blog posts, and more on a schedule.
  </Accordion>

  <Accordion title="API-First">
    Everything available in the dashboard is also available via the API. Generate content, manage repos, and publish programmatically.
  </Accordion>
</AccordionGroup>

## Need Help?

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get up and running in under 5 minutes
  </Card>

  <Card title="API Reference" icon="terminal" href="/api-reference/overview">
    Explore the full API documentation
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.