How factory-ai/factory works
Project type and purpose
• This repo is primarily a documentation site (MDX/Markdown content + examples) for the “Factory” agent-native development platform.
• It contains:
• Docs in /docs (MDX files, images, CSS)
• A small examples folder (/examples)
• Build scripts (e.g. convert_md_to_mdx.sh)
• CI workflows (.github/workflows/…) for issue-label Slack notifications and site builds
File structure for architectural clues
• Content layer: /docs, /community-builds.md, /examples
• Build tooling: convert_md_to_mdx.sh, docs/docs.json, style assets
• CI/CD: GitHub Actions workflows under .github/workflows
• Output target: A static site (likely powered by a static-site generator such as Docusaurus, Next.js, etc.) and deployed to a CDN or GitHub Pages
• Integrations: Slack (issue-label notifications), GitHub Discussions, external links to CLI, Web, VS Code marketplace
README for refinements
• Confirms core deliverable = static documentation site
• Mentions community builds (a dynamic list fed from community-builds.md)
• Points to external services: CLI Quickstart, VS Code Extension, Community Discussions
Architectural patterns & design principles
• Content-as-Code: All docs live in Git, versioned, PR-driven
• Static-Site Generation (SSG): Pre-render all pages for fast, cacheable delivery
• Modular Documentation: Directory structure mirrors site navigation, MDX for interleaving React (if used)
• CI-Driven Deployments: Builds and deployments triggered on main or tagged commits
• Decoupled Integrations: Slack notifications via a separate workflow, community builds updated independently
Sample component list
1. Developer Workstation (authoring MDX)
2. GitHub Repo (docs & examples)
3. Build Script (convert_md_to_mdx.sh, docs.json)
4. Static-Site Generator (Docusaurus/Next)
5. GitHub Actions Runner
6. CDN / Hosting (Vercel/Netlify/GitHub Pages)
7. Slack Webhook (issue-label notifications)
8. GitHub Discussions & Issues portal