January 1, 0001
Core Principles
The 8 engineering principles that guide all NAEOS design decisions.
Documentation
Learn how to use NAEOS with comprehensive guides and references.
Welcome to the NAEOS documentation. Here you’ll find everything you need to get started and master the platform.
Getting Started
- Getting Started — Quick start guide to install and run your first pipeline
- Installation — Detailed installation instructions for all platforms
- Quick Reference — Common commands, patterns, and configurations at a glance
- Core Principles — The 8 engineering principles that guide NAEOS
Architecture & Design
- Architecture — Deep dive into NAEOS architecture and design
- Project Structure — Repository layout and directory organization
- Spec Language — NAEOS Specification Language v2 syntax and features
- NEIR Model — The canonical NAEOS Engineering Intermediate Representation
- Pipeline Engine — The 9-stage DAG pipeline from parsing to export
Features
- AI Compiler — Compile NEIR to AI instruction sets for 6 platforms
- Context Bundles — Generate LLM-optimized project summaries
- Industry Profiles — Pre-configured profiles for SaaS, AI, FinTech, Healthcare, Government
- Plugin SDK — Extend NAEOS with custom plugins and generators
- Validation — Multi-level validation for specs, modules, services, and policies
- Governance — Policy system, review workflows, and audit trails
Reference
- CLI Reference — Complete command reference for all 35+ CLI commands
- API Reference — Interactive API documentation with Swagger UI
- Cloud Deployment — Deploy to AWS, GCP, or Azure
- Troubleshooting — Common issues and solutions
- Glossary — Key terms and definitions
- Contributing — Guide for contributing to NAEOS
External Resources
- GitHub Repository — Source code and issues
- API Reference — Interactive API documentation
- OpenAPI Spec — OpenAPI 3.0 specification
January 1, 0001
Quick Reference
Common commands, patterns, and configurations at a glance.
January 1, 0001
Cloud Deployment
Deploy NAEOS-generated projects to AWS, GCP, or Azure with integrated cloud planning and provisioning.
January 1, 0001
Context Bundles
Generate LLM-optimized project summaries for AI coding assistants.
January 1, 0001
Industry Profiles
Pre-configured profiles for SaaS, AI Agent, FinTech, Healthcare, and Government projects.
January 1, 0001
Troubleshooting
Common issues and solutions when working with NAEOS.
January 1, 0001
Validation
Multi-level validation system for specifications, modules, services, and policies.
January 1, 0001
API Reference
Interactive API documentation for the NAEOS REST API.
January 1, 0001
Governance
Policy system, review workflows, and audit trails for NAEOS.
January 1, 0001
Contributing
Guide for contributing to the NAEOS project.
January 1, 0001
Glossary
Key terms and definitions used throughout the NAEOS platform.
January 1, 0001
Project Structure
Repository layout and directory organization for the NAEOS codebase.
January 1, 0001
AI Compiler
Transform NEIR into AI instruction sets for 6 coding assistants.
January 1, 0001
Architecture
Deep dive into NAEOS architecture and design principles.
January 1, 0001
CLI Reference
Complete command reference for all 35+ NAEOS CLI commands.
January 1, 0001
Getting Started
Install NAEOS and run your first pipeline in minutes.
January 1, 0001
Installation
Detailed installation instructions for NAEOS on all platforms.
January 1, 0001
NEIR Model
The NAEOS Engineering Intermediate Representation — the canonical system model.
January 1, 0001
Pipeline Engine
The 9-stage DAG pipeline — from parsing to export.
January 1, 0001
Plugin SDK
Extend NAEOS with custom plugins, generators, and validators.
January 1, 0001
Spec Language
The NAEOS Specification Language v2 — syntax, features, and capabilities.