The Web Actor Programming Model Whitepaper

This repository contains the documentation website for the Actor Programming Model, a new concept for building serverless microapps called Actors. The site is built using Astro and provides comprehensive documentation about developing, sharing, and integrating Actors.

Features

• Built with Astro for optimal static site generation
• Responsive design with Tailwind CSS
• Interactive Table of Contents with progress tracking
• Code syntax highlighting with copy functionality
• Dark mode support
• MDX content support with custom components
• Modal-based navigation system for internal links
• Smooth scroll behavior for navigation
• Banner component for improved inner page context
• Automatic sitemap generation for improved SEO

Tech Stack

• Astro - Static Site Generator
• Tailwind CSS - Styling
• MDX - Content
• TypeScript - Type Safety
• Sharp - Image optimization
• ESLint - Code linting
• Prettier - Code formatting
• Vercel - Deployment

Prerequisites

• Node.js v16+ (recommended: v18.0 or higher)

Installation

1. Clone the repository:

git clone https://github.com/vancura/developer-actor.git
cd developer-actor

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

Available Scripts

• npm run dev - Start development server with host access
• npm run build - Build for production
• npm run preview - Preview production build
• npm run clean - Clean dist and node_modules directories
• npm run format - Format code with Prettier
• npm run lint - Run ESLint checks
• npm run lint:fix - Fix ESLint issues and format code

Project Structure

src/
   ├── components/ # Reusable UI components
   ├── config/ # Configuration files
   ├── content/ # MDX content files
   ├── layouts/ # Page layouts
   ├── pages/ # Astro pages
   ├── styles/ # Global styles
   ├── types/ # TypeScript types
   └── utils/ # Utility functions

Styling

The project uses Tailwind CSS for styling with custom configurations for:

• Typography
• Colors
• Responsive design
• Dark mode

Custom styles for MDX content can be found in src/styles/mdx-content.css.

SEO

The site implements comprehensive SEO practices including:

• Meta tags
• Canonical URLs
• OpenGraph data
• Structured data
• Automatic sitemap generation for search engine crawling

SEO configuration can be found in the BaseHead component: src/components/BaseHead.astro.

Performance

The site implements various performance optimizations:

• Image optimization with Sharp
• Asset caching through Vercel
• CSS and JavaScript minification
• Responsive images with multiple formats

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

• Václav Vančura - Designer, Developer
• Adam Kliment - Owner

Acknowledgments

• Apify Team for creating the Actor Programming Model
• Astro for the amazing static site generator
• Tailwind CSS for the utility-first CSS framework