Centralized documentation and development standards for AI-powered Odoo development. This repository provides consistent coding standards, guidelines, and AI assistant configurations that can be shared across multiple Odoo projects (15+), designed primarily for AI agents with human developer support.
- 🤖 AI Agent Optimized - Pre-configured for AI assistants (Augment, Cursor, etc.)
- 📚 Comprehensive Documentation - Complete coding standards and guidelines
- 🔗 One-Line Setup - Instant integration with any Odoo project
- 🔄 Auto-Update - Keep standards current across all projects
- 🏗️ Template System - Ready-to-use AI and development configurations
Install in default directory: (/opt/odoo/odoo-docs)
curl -sSL https://raw.githubusercontent.com/solutionsunity/odoo-docs/main/install.sh | bashInstall in specific project directory:
# Syntax: bash -s [project_path]
curl -sSL https://raw.githubusercontent.com/solutionsunity/odoo-docs/main/install.sh | bash -s /path/to/projectWhat the installer does:
- 📥 Clones/updates the odoo-docs repository to
/opt/odoo/odoo-docs(standardized location) - 📋 Copies configuration templates to your project directory
- 📝 Guides you to run
link.shnext
If you already have odoo-docs installed, simply create symlinks from your project:
# From your project directory (e.g., /opt/odoo/workarea)
/opt/odoo/odoo-docs/link.shWhat the linker does:
- 📋 Copies templates to odoo-docs root (if missing)
- 🔗 Creates symlink to
docs/directory - 🔗 Creates symlink to
.augment-guidelines - 🔗 Creates symlink to
env-reference.json - 📝 Updates
.gitignorewith proper root-relative paths (/docs,/.augment-guidelines,/env-reference.json) - ✅ Validates target directory and prevents conflicts
- 🔄 Detects existing symlinks and avoids duplicates
If you prefer manual setup:
# 1. Clone the repository
git clone https://github.com/solutionsunity/odoo-docs.git /opt/odoo/odoo-docs
# 2. Navigate to your project
cd /path/to/your/odoo-project
# 3. Copy templates for private configuration
cp /opt/odoo/odoo-docs/templates/.augment-guidelines.template .augment-guidelines
cp /opt/odoo/odoo-docs/templates/env-reference.json.template env-reference.json
# 4. Create symlinks and update .gitignore
/opt/odoo/odoo-docs/link.shodoo-docs/
├── docs/ # 📚 Development standards and guidelines
│ ├── git.md # Git commit standards
│ ├── code_standard.md # Backend coding standards
│ ├── frontend.md # Frontend/portal standards
│ ├── owl.md # OWL component guidelines
│ ├── migration_guideline.md # Migration procedures
│ ├── email_standard.md # Email template standards
│ ├── module_icon.png # Standard module icon
│ └── sync.sh # Synchronization script
├── templates/ # 🔧 Configuration templates
│ ├── .augment-guidelines.template
│ └── env-reference.json.template
├── .augment-guidelines # 🤖 AI assistant configuration
├── env-reference.json # 🔧 Environment reference configuration
├── link.sh # 🔗 Symlink creation script
└── README.md # This file
| Document | Description | Purpose |
|---|---|---|
| Git Standards | Commit message format and workflow | Consistent git history |
| Code Standards | Backend development guidelines (15+) | Clean, maintainable code |
| Frontend Standards | Portal and frontend development | Consistent UI/UX |
| OWL Guidelines | OWL component development | Modern JS framework |
| Migration Guide | Version migration procedures | Smooth upgrades |
| Email Standards | Email template guidelines | Professional communication |
This repository is optimized for AI agents like Augment, Cursor, GitHub Copilot, and others:
.augment-guidelines- Contains AI-specific instructions and context- Comprehensive docs - All standards in easily parseable markdown
- Auto-sync - AI can run
./docs/sync.shto get latest updates - Template system - AI can copy and customize configurations
- Session start: Run
./docs/sync.shto ensure latest updates - Before coding: Reference
./docs/for current guidelines - During development: Follow standards in documentation
- Before commits: Check
./docs/git.mdfor commit format
Keep your documentation and standards current:
# From any project with symlinked docs
./docs/sync.shThis script automatically:
- Pulls the latest changes from this repository
- Updates all symlinked documentation across your projects
- Ensures you're always using the current standards
Use the provided templates to set up your development environment:
.augment-guidelines.template- AI assistant configurationenv-reference.json.template- Development environment settings
Copy and customize these templates for your specific needs.
- Always symlink - Don't copy files, use symlinks to stay updated
- Sync regularly - Run
./docs/sync.shbefore starting work - Follow standards - Check documentation before coding
- Contribute back - Improve standards for everyone
A: Simply run link.sh again after git init. The script detects git repositories and will create the .gitignore entries automatically.
git init
/opt/odoo/odoo-docs/link.shA: Yes! The link.sh script works in any directory. It will create symlinks but skip .gitignore updates if git isn't initialized. You'll see a helpful message about this.
A:
install.sh- Copies templates for customization (creates actual files you can edit)link.sh- Creates symlinks to shared files (always stays in sync with updates)
Use install.sh when you want to customize configurations, use link.sh when you want to share the central configurations.
A: Just run link.sh again. It will recreate any missing symlinks automatically.
A: Run ./docs/sync.sh from any project with symlinked docs. This pulls the latest updates from the central repository.
A: No! The .gitignore uses root-relative paths (/docs) that only ignore the symlinked docs directory at your repository root, not module documentation directories.
We welcome contributions to improve these standards:
- Fork this repository
- Create a feature branch
- Make your improvements
- Submit a pull request
MIT License - Feel free to use and adapt for your projects.