OwlStack Documentation

The official documentation site for OwlStack - a unified social media publishing SDK for PHP.

🌐 Live site: docs.owlstack.dev

What's Inside

• Getting Started - Installation, quick start guides for Core, Laravel, and WordPress
• Core Concepts - Posts, media, platform config, publishing, delivery status, error handling
• Platforms - Guides for all 11 supported platforms (Telegram, Twitter/X, Facebook, LinkedIn, Discord, Instagram, Pinterest, Reddit, Slack, Tumblr, WhatsApp)
• Formatting - Platform formatters, character limits, hashtag extraction
• Authentication - OAuth flows, access tokens, token storage
• Events - Event system, dispatchers, listeners
• Frameworks - Laravel and WordPress integration guides
• Pro Features - Batch publishing, scheduling, queues, delivery logging, templates, automation, AI, analytics
• Extending - Custom platforms, formatters, and HTTP clients
• Blog - Announcements and migration guides

Setup

npm install

Development

npm start

Starts a local dev server at http://localhost:3000. Changes are hot-reloaded.

Locale-specific previews

npm run start:fa   # Farsi (RTL)
npm run start:zh   # Chinese
npm run start:ja   # Japanese

Build

npm run build

Generates static files into the build directory for all locales (en, fa, zh, ja).

Versioning

Docs are versioned. The current stable version is 1.0. To create a new version snapshot:

npx docusaurus docs:version X.Y

Project Structure

docs/              # Current (next) version documentation
versioned_docs/    # Snapshotted version docs (e.g. version-1.0/)
blog/              # Blog posts
src/               # React components, pages, CSS
  components/      # ProBadge, ProFeature, PlatformTable
  css/             # Custom styles
  pages/           # Homepage
static/img/        # Logos and images
i18n/              # Translation files (fa, zh, ja)

Contributing

1. Fork the repo
2. Create a branch (git checkout -b docs/my-change)
3. Make your changes
4. Run npm run build to verify no broken links
5. Submit a pull request

License

This documentation is part of the OwlStack project.