Flowless Docs

Appearance

On this page

Flowless Documentation ​

Fully managed authentication service for modern applications

This is the official documentation for Flowless, the authentication backend service provided by Pubflow.

📚 Documentation Structure ​

.
├── index.md                    # Landing page
├── introduction.md             # What is Flowless?
├── getting-started.md          # Quick start guide
├── core-concepts.md            # Core concepts
├── architecture.md             # Architecture overview
├── instance-setup/             # Instance setup guides
│   ├── creating-instance.md
│   ├── configuration.md
│   ├── environment.md
│   ├── email.md
│   └── social-auth.md
├── modules/                    # Module guides and product extensions
│   ├── index.md
│   ├── blog.md
│   └── two-factor.md
├── api/                        # API reference
│   ├── authentication.md
│   ├── module-hub.md
│   ├── blog.md
│   ├── two-factor.md
│   ├── modules.md
│   ├── token-auth.md
│   ├── social-auth.md
│   ├── sessions.md
│   ├── users.md
│   └── admin.md
├── guides/                     # Integration guides
│   ├── user-registration.md
│   ├── login-flow.md
│   ├── password-reset.md
│   ├── email-verification.md
│   ├── social-login.md
│   ├── session-management.md
│   ├── bridge-integration.md
│   └── testing.md
├── security/                   # Security documentation
│   ├── authentication.md
│   ├── sessions.md
│   ├── rate-limiting.md
│   ├── validation.md
│   └── best-practices.md
├── monitoring/                 # Monitoring and analytics
│   ├── dashboard.md
│   ├── analytics.md
│   ├── logs.md
│   └── alerts.md
├── llms.txt                    # LLM-friendly summary
└── llms-full.txt               # Complete LLM documentation

🛠️ Development ​

Prerequisites ​

  • Node.js 18+
  • npm or yarn

Install Dependencies ​

bash
npm install

Run Development Server ​

bash
npm run dev

The documentation will be available at http://localhost:5173

Build for Production ​

bash
npm run build

Preview Production Build ​

bash
npm run preview

📝 Contributing ​

We welcome contributions to improve the documentation!

Guidelines ​

  1. Clarity: Write clear, concise documentation
  2. Examples: Include code examples for all concepts
  3. Accuracy: Ensure all information is accurate and up-to-date
  4. Consistency: Follow the existing style and structure

Making Changes ​

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test locally with npm run dev
  5. Submit a pull request

🎨 Style Guide ​

Writing Style ​

  • Use active voice
  • Write in second person ("you")
  • Keep sentences short and clear
  • Use code examples liberally
  • Include warnings for security-critical information

Code Examples ​

typescript
// ✅ Good: Clear, commented, complete
async function login(email: string, password: string) {
  const response = await fetch(`${FLOWLESS_URL}/auth/login`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ email, password }),
  });
  
  const data = await response.json();
  return data;
}

// ❌ Bad: Incomplete, no context
fetch('/auth/login', { body: data });

Markdown Conventions ​

  • Use ### for main sections
  • Use #### for subsections
  • Use bold for emphasis
  • Use code for inline code
  • Use code blocks with language tags
  • Use tables for structured data
  • Use admonitions (tip, warning, danger) for important notes

🔧 VitePress Configuration ​

The documentation uses VitePress with the following configuration:

  • Theme: Default VitePress theme
  • Logo: Pubflow logo from cloud.notside.com
  • Color: #006AFF (Pubflow blue)
  • Font: Roboto Slab
  • Search: Local search enabled

📄 License ​

This documentation is licensed under AGPL-3.0.

Copyright © 2025 Pubflow, Inc.

🆘 Support ​

Need help with the documentation?

Built with ❤️ by the Pubflow team