Documentation Hub
Find the Right Documentation for Your Needs
Whether you are a merchant managing your store, a developer building custom solutions, or an agency migrating clients to Mage-OS, our community-maintained documentation has the resources to help you succeed.
Documentation Resources
Browse Documentation
Find What You Need
Choose your path based on your role and experience level. Our documentation is organized to help you find exactly what you need.
Getting Started
New to Mage-OS? Start here. Installation guides, migration from Magento, system requirements, and first-time setup tutorials to get your store running quickly.
Developer Documentation
Deep dive into Mage-OS architecture, dependency injection, module development, event observers, and coding best practices. Ideal for developers building custom functionality.
Merchant User Guide
Learn to manage your store: catalog and inventory management, order processing, customer accounts, marketing tools, and admin panel configuration.
API Reference
Complete REST and GraphQL API documentation for integrations, headless commerce setups, third-party connections, and custom application development.
Extension Development
Build custom modules, plugins, and extensions. Covers service contracts, repositories, database schema, UI components, and the dependency injection framework.
Theme Development
Create custom storefronts with layouts, templates, and CSS/LESS. Covers Luma, Blank, Breeze, and Hyva themes, plus JavaScript components.
Getting Oriented
How to Use Our Documentation
Step 1: Identify Your Role
Are you a merchant managing your store, a developer building customizations, or an agency implementing for clients? Each path has dedicated resources.
Step 2: Choose Your Starting Point
New to Mage-OS? Start with the Quick Start Guide. Migrating from Magento? Check the Migration Guide. Already running? Explore advanced topics.
Step 3: Explore the DevDocs
Our comprehensive developer documentation covers architecture, modules, APIs, theming, and more. Bookmark it for reference.
Step 4: Join the Community
Stuck on something? Ask in Discord, check GitHub discussions, or search Magento Stack Exchange. The community is here to help.
Popular Resources
Quick Links
The most commonly accessed resources to help you get up and running fast.
Get Mage-OS running in under 30 minutes. Covers Composer installation, database setup, and initial configuration.
Seamlessly migrate from Magento Open Source. Update your composer.json, run a few commands, and go live with zero downtime.
PHP 8.3+, MySQL 8.0+, OpenSearch, Composer 2.x, and hosting specifications for optimal Mage-OS performance.
Detailed changelog for each version including new features, bug fixes, security patches, and upgrade instructions.
Frontend Development
Choose Your Frontend Stack
Multiple Paths to Your Perfect Storefront
Mage-OS supports a variety of frontend technologies, from traditional themes to cutting-edge headless solutions. Choose the stack that fits your team and project requirements.Luma & Blank (Default)
The classic Magento themes. Fully featured, widely supported, and a good starting point for custom themes.
Breeze Frontend
A free, open-source frontend that replaces the default JS stack. Built-in critical CSS splitting and excellent performance.
Hyva Themes
A performance-oriented paid theme using Alpine.js and Tailwind CSS. Great developer experience and fast time-to-market.
Headless / PWA
Options include Vue Storefront, GraphCommerce, Rapidez, and more. Perfect for modern, app-like experiences.
Get Help & Connect
Community Resources
Join a thriving community of developers, merchants, and agencies. Get support, share knowledge, and contribute to the future of open-source commerce.
Real-time support from community members and core developers. Weekly tech meetings every Thursday.
Ask questions, share ideas, propose features, and discuss technical decisions with the community.
Report bugs, request features, and track development progress on our GitHub repositories.
Find answers to technical questions. Mage-OS shares the same codebase, so most Magento answers apply.
Community-curated list of useful Magento 2 modules, tools, and resources on GitHub.
Level Up Your Skills
Learning & Training Resources
From Beginner to Expert
Invest in your skills with training resources from trusted community educators. These courses cover everything from Magento fundamentals to advanced development techniques.M.academy
Comprehensive Magento development courses from beginner to advanced. The Coding Kickstart is ideal for new developers.
Yireo Training
In-depth Magento 2 training covering frontend development, backend development, and performance optimization.
SwiftOtter
Developer training programs and certification preparation for Magento 2 professionals.
MageMastery
Video courses and workshops covering Magento 2 development fundamentals and advanced topics.
Questions & Answers
Documentation FAQs
Common questions about finding and using Mage-OS documentation.
Where is the official Mage-OS documentation?
The primary developer documentation is at devdocs.mage-os.org. This includes architecture guides, module development, API references, and Mage-OS specific features. For merchant user guides, the Adobe Commerce documentation at Experience League remains applicable since Mage-OS maintains full compatibility.
Can I use Magento documentation for Mage-OS?
Yes! Mage-OS is fully compatible with Magento Open Source, so the vast majority of Magento documentation, tutorials, and Stack Exchange answers apply directly. Our DevDocs highlight Mage-OS specific differences and enhancements.
How do I contribute to the documentation?
Our documentation is open source and we welcome contributions. Visit our DevDocs GitHub repository to submit improvements, fix typos, or add new guides. Every contribution helps the community.
Where can I get help if I am stuck?
Join our Discord server for real-time community support. You can also ask questions on Magento Stack Exchange or start a discussion on GitHub.
What documentation is specific to Mage-OS vs Magento?
Mage-OS specific documentation covers: Mage-OS Lab features (AI translation, PCI DSS 4.0 compliance, performance optimizations), the Mage-OS repository and package structure, migration guides, and community modules. General Magento architecture, APIs, and admin features are documented in the shared ecosystem.
Is there documentation for the Mage-OS versioning strategy?
Yes! Visit our Releases page for version history and upgrade guides. We also document our versioning strategy which explains how Mage-OS versions relate to Magento Open Source releases.
Stay Connected
Official Mage-OS Resources
Browse the source code, contribute to development, and explore our repositories.
Cannot Find What You Need?We Want to Help.
Our documentation is community-maintained and always improving. If something is missing or unclear, let us know on Discord or contribute directly on GitHub. Together, we are building the best documentation for open-source commerce.
