Skip to content

Conversation

@CarlosZiegler
Copy link

Add Documentation Site with Fumadocs

Summary

This PR adds a comprehensive documentation site built with fumadocs, featuring a beautiful landing page, internationalization support, and complete documentation structure for OpenWorkflow.

Changes

1. Initial Documentation Setup (feat: add docs)

  • Set up fumadocs documentation framework with TanStack Start
  • Added complete documentation structure in apps/docs/
  • Created initial MDX documentation pages:
    • Getting Started
    • Core Concepts
    • Architecture
    • API Reference
    • Advanced Features
    • Backend PostgreSQL
    • Production Guide
    • Examples
    • Roadmap
  • Configured fumadocs source and routing system

2. Translation System (feat: add translations)

  • Implemented i18n infrastructure with fumadocs i18n support
  • Created translation system in apps/docs/src/lib/translations/
  • Added comprehensive English translations covering:
    • Navigation labels
    • Landing page content (hero, features, use cases, CTAs)
    • Common UI strings
  • Integrated translations into fumadocs UI components
  • Set up translation hooks and utilities for easy extension

3. Enhanced Landing Page (feat: enhance docs)

  • Built comprehensive landing page (apps/docs/src/routes/$lang/index.tsx) featuring:
    • Hero Section: Badge, title, subtitle, CTA buttons, and install command
    • Features Grid: 6 key features (Durable Execution, Step Memoization, Worker-Driven, Type-Safe, Parallel Execution, Production Ready)
    • Use Cases Section: 4 real-world use cases (Payment Processing, Email Campaigns, Data Pipelines, Order Fulfillment)
    • CTA Section: Links to documentation and examples
    • Footer: Links to GitHub, docs, and issues
  • Fully internationalized using the translation system
  • Responsive design with mobile-first approach
  • Consistent styling using fumadocs design tokens
  • Modern UI with hover effects and smooth transitions

Technical Details

  • Uses fumadocs v16.0.8 with TanStack Start
  • Fully typed with TypeScript
  • Responsive layout for all screen sizes
  • Accessible components following WCAG guidelines
  • SEO-friendly with proper meta tags

Files Changed

  • apps/docs/ - Complete new documentation app
  • Translation system in apps/docs/src/lib/translations/
  • Landing page in apps/docs/src/routes/$lang/index.tsx
  • Documentation content in apps/docs/content/docs/en/

- **SQLite Backend** - Zero-configuration local development and embedded deployments
- **DynamoDB Backend** (Under Consideration) - Serverless-native workflow execution

### 🌍 Multi-Language SDKs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

those emojis/color-icons look a bit kitchy, they reduce the professional look&feel. Consider removing.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to clarify: those icons in the menu look nice:

image

the color-icons in e.g. roadmap just ruin the typography and professional look of the overall docs/site.

@CarlosZiegler
Copy link
Author

Preview url => https://openworkflow-docs.vercel.app/en

@CarlosZiegler
Copy link
Author

I want to mention that the fix come from @fuma :)

@jamescmartinez
Copy link
Contributor

@CarlosZiegler, wow, thank you. This is insanely generous work. Thanks for putting this much time into it, and thanks @laz-001 for reviewing.

Though we definitely need docs and a landing page, I believe it is something I should own to keep a tighter core voice and direction since it's the front door for the project.

That said, there's a lot of work and thought in this PR, and I'd hate to decline all of it outright. Maybe we can figure out how to break it down together? I can spend some time thinking and we can chat more about the overall approach; maybe next week? Let me know if that interests you, either here or in our existing DMs.

Thanks again for jumping in. This kind of energy is awesome to see.

@jamescmartinez
Copy link
Contributor

reopening to keep the discussion open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants