[DOC] Actualizar documentación a estándares OCA y preparar logo CriptoMart
- Renombrar README.md a README_DEV.md en todos los addons custom - Crear README.rst siguiendo estructura OCA oficial - Crear directorios readme/ con fragmentos .rst (DESCRIPTION, INSTALL, CONFIGURE, USAGE, CONTRIBUTORS, CREDITS) - Actualizar créditos: Criptomart (autor) + Elika Bilbo (financiador) - Actualizar __manifest__.py con maintainers correctos - Crear estructura static/description/ para logo en 5 addons - Agregar documentación de logo (LOGO_INSTRUCTIONS.md, install_logo.sh) - Actualizar copilot-instructions.md con referencias a OCA_DOCUMENTATION.md - Crear docs/OCA_DOCUMENTATION.md con guía completa de estructura - Crear docs/RESUMEN_CAMBIOS_DOCUMENTACION.md con resumen detallado Addons actualizados: - website_sale_aplicoop - product_sale_price_from_pricelist - product_pricelist_total_margin - product_price_category_supplier - account_invoice_triple_discount_readonly
This commit is contained in:
parent
b31df7b9d8
commit
4a4639f13a
56 changed files with 1778 additions and 674 deletions
44
.github/copilot-instructions.md
vendored
44
.github/copilot-instructions.md
vendored
|
|
@ -50,6 +50,10 @@ docker-compose run odoo odoo -d odoo --test-enable --stop-after-init -u addon_na
|
|||
- Consulta este archivo para patrones globales.
|
||||
- Consulta los archivos de skills para detalles por lenguaje.
|
||||
- Para troubleshooting de templates, revisa `docs/QWEB_BEST_PRACTICES.md` y `docs/FINAL_SOLUTION_SUMMARY.md`.
|
||||
- **Para documentación de addons**: Sigue los estándares OCA descritos en `docs/OCA_DOCUMENTATION.md`
|
||||
- Estructura de directorios readme/ con fragmentos .rst
|
||||
- Créditos: Criptomart (autor) + Elika Bilbo (financiador)
|
||||
- Logo: CriptoMart en `static/description/icon.png` (ver `docs/LOGO_INSTRUCTIONS.md`)
|
||||
|
||||
# GitHub Copilot Instructions - Kidekoop Addons Custom
|
||||
|
||||
|
|
@ -177,7 +181,7 @@ addons-cm/
|
|||
|
||||
## Addon References
|
||||
|
||||
**Para arquitectura, detalles de implementación y uso específico de cada addon, consultar su `README.md` individual.**
|
||||
**Para arquitectura, detalles de implementación y uso específico de cada addon, consultar su `README.rst` (documentación oficial) o `README_DEV.md` (detalles técnicos).**
|
||||
|
||||
### Addons OCA No Modificados
|
||||
|
||||
|
|
@ -190,10 +194,12 @@ addons-cm/
|
|||
|
||||
### Addons Custom Propios
|
||||
|
||||
- [account_invoice_triple_discount_readonly](../account_invoice_triple_discount_readonly/README.md) - Fix bug descuentos
|
||||
- [product_price_category_supplier](../product_price_category_supplier/README.md) - Gestión categorías por proveedor
|
||||
- [product_sale_price_from_pricelist](../product_sale_price_from_pricelist/README.md) - Auto-precio basado en compra
|
||||
- [website_sale_aplicoop](../website_sale_aplicoop/README.md) - Sistema eskaera completo
|
||||
- [account_invoice_triple_discount_readonly](../account_invoice_triple_discount_readonly/README.rst) - Fix bug descuentos
|
||||
- [product_price_category_supplier](../product_price_category_supplier/README.rst) - Gestión categorías por proveedor
|
||||
- [product_sale_price_from_pricelist](../product_sale_price_from_pricelist/README.rst) - Auto-precio basado en compra
|
||||
- [website_sale_aplicoop](../website_sale_aplicoop/README.rst) - Sistema eskaera completo
|
||||
|
||||
**Nota**: Todos los addons custom siguen la estructura OCA con readme/ fragmentos. Ver [docs/OCA_DOCUMENTATION.md](../docs/OCA_DOCUMENTATION.md) para detalles.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
|
|
@ -546,18 +552,20 @@ import pdb; pdb.set_trace() # Set breakpoint
|
|||
|
||||
## Documentation Standards
|
||||
|
||||
### README.md Structure
|
||||
### OCA README Structure
|
||||
|
||||
Cada addon debe tener un README.md con:
|
||||
Cada addon custom sigue la **estructura OCA** con fragmentos en `readme/`:
|
||||
|
||||
1. **Title & Summary**: Qué hace el addon
|
||||
2. **Features**: Lista de funcionalidades
|
||||
3. **Dependencies**: Addons requeridos
|
||||
4. **Installation**: Comandos de instalación
|
||||
5. **Configuration**: Settings necesarios
|
||||
6. **Usage**: Flujo de trabajo típico
|
||||
7. **Technical Details**: Modelos, campos, métodos
|
||||
8. **Translations**: Estado de traducciones (si aplica)
|
||||
- `readme/DESCRIPTION.rst` - Descripción y características
|
||||
- `readme/INSTALL.rst` - Instalación y dependencias
|
||||
- `readme/CONFIGURE.rst` - Configuración post-instalación
|
||||
- `readme/USAGE.rst` - Guía de uso
|
||||
- `readme/CONTRIBUTORS.rst` - Contribuidores
|
||||
- `readme/CREDITS.rst` - Créditos (Criptomart + Elika Bilbo)
|
||||
- `README.rst` - README oficial generado/manual
|
||||
- `README_DEV.md` - Notas técnicas para desarrolladores
|
||||
|
||||
**Ver**: [docs/OCA_DOCUMENTATION.md](../docs/OCA_DOCUMENTATION.md) para estructura completa.
|
||||
|
||||
### **manifest**.py Structure
|
||||
|
||||
|
|
@ -571,8 +579,8 @@ Todos los addons custom deben seguir esta estructura:
|
|||
"version": "18.0.X.Y.Z", # X=major, Y=minor, Z=patch
|
||||
"category": "category_name",
|
||||
"summary": "Short description",
|
||||
"author": "Odoo Community Association (OCA), Your Company",
|
||||
"maintainers": ["maintainer_github"],
|
||||
"author": "Odoo Community Association (OCA), Criptomart",
|
||||
"maintainers": ["Criptomart"],
|
||||
"website": "https://github.com/OCA/repo",
|
||||
"license": "AGPL-3",
|
||||
"depends": [
|
||||
|
|
@ -658,7 +666,7 @@ Settings > Website > Shop Performance
|
|||
- v18.0.1.3.0: Lazy loading, mejora de rendimiento de 10-20s → 500-800ms
|
||||
- Refactor de template rendering: Mover lógica QWeb al controller
|
||||
|
||||
Ver [website_sale_aplicoop/README.md](../website_sale_aplicoop/README.md) y [docs/LAZY_LOADING.md](../docs/LAZY_LOADING.md) para detalles.
|
||||
Ver [website_sale_aplicoop/README.rst](../website_sale_aplicoop/README.rst) y [docs/LAZY_LOADING.md](../docs/LAZY_LOADING.md) para detalles.
|
||||
|
||||
### Triple Discount System
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue