- 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
190 lines
6 KiB
Markdown
190 lines
6 KiB
Markdown
# Actualización de Documentación OCA - Resumen de Cambios
|
||
|
||
**Fecha:** 21 de febrero de 2026
|
||
**Responsable:** GitHub Copilot (Claude Sonnet 4.5)
|
||
|
||
## Resumen Ejecutivo
|
||
|
||
Se ha actualizado la documentación de 5 addons custom del proyecto para seguir los **estándares OCA** y asegurar que los créditos incluyan correctamente:
|
||
|
||
- **Autor**: Criptomart
|
||
- **Financiador**: Elika Bilbo
|
||
|
||
## Addons Actualizados
|
||
|
||
### 1. website_sale_aplicoop
|
||
- ✅ README.md → README_DEV.md (renombrado para desarrollo)
|
||
- ✅ README.rst actualizado con estructura OCA completa
|
||
- ✅ Directorio readme/ con 6 fragmentos .rst
|
||
- ✅ Créditos: Criptomart + Elika Bilbo
|
||
|
||
### 2. product_sale_price_from_pricelist
|
||
- ✅ README.md → README_DEV.md
|
||
- ✅ README.rst creado siguiendo estándar OCA
|
||
- ✅ Directorio readme/ creado con 6 fragmentos .rst
|
||
- ✅ Créditos: Criptomart + Elika Bilbo
|
||
|
||
### 3. product_pricelist_total_margin
|
||
- ✅ README.md → README_DEV.md
|
||
- ✅ README.rst creado siguiendo estándar OCA
|
||
- ✅ Directorio readme/ creado con 6 fragmentos .rst
|
||
- ✅ Créditos: Criptomart + Elika Bilbo
|
||
- ✅ __manifest__.py actualizado (Copyright correcto)
|
||
|
||
### 4. product_price_category_supplier
|
||
- ✅ README.md → README_DEV.md
|
||
- ✅ README.rst actualizado con créditos completos
|
||
- ✅ Directorio readme/ creado con 6 fragmentos .rst
|
||
- ✅ Créditos: Criptomart + Elika Bilbo
|
||
- ✅ __manifest__.py actualizado con maintainers
|
||
|
||
### 5. account_invoice_triple_discount_readonly
|
||
- ✅ README.md → README_DEV.md
|
||
- ✅ README.rst creado siguiendo estándar OCA
|
||
- ✅ Directorio readme/ creado con 6 fragmentos .rst
|
||
- ✅ Créditos: Criptomart + Elika Bilbo
|
||
- ✅ __manifest__.py actualizado con maintainers
|
||
|
||
## Estructura Creada
|
||
|
||
Cada addon ahora sigue esta estructura:
|
||
|
||
```
|
||
addon_name/
|
||
├── __manifest__.py # Manifest con autor "Criptomart"
|
||
├── README.rst # README oficial OCA
|
||
├── README_DEV.md # README para desarrolladores (ex-README.md)
|
||
└── readme/ # Fragmentos para README.rst
|
||
├── DESCRIPTION.rst # Descripción del módulo
|
||
├── INSTALL.rst # Instrucciones de instalación
|
||
├── CONFIGURE.rst # Configuración
|
||
├── USAGE.rst # Guía de uso
|
||
├── CONTRIBUTORS.rst # Lista de contribuidores
|
||
└── CREDITS.rst # Créditos (incluye Elika Bilbo)
|
||
```
|
||
|
||
## Fragmentos Creados
|
||
|
||
Para cada addon se han creado 6 archivos .rst en el directorio `readme/`:
|
||
|
||
1. **DESCRIPTION.rst**: Descripción breve con características principales
|
||
2. **INSTALL.rst**: Pasos de instalación y dependencias
|
||
3. **CONFIGURE.rst**: Configuración post-instalación
|
||
4. **USAGE.rst**: Guía de uso con ejemplos prácticos
|
||
5. **CONTRIBUTORS.rst**: Lista de contribuidores (Criptomart)
|
||
6. **CREDITS.rst**: Créditos completos con Criptomart (autor) y Elika Bilbo (financiador)
|
||
|
||
## Manifiestos Actualizados
|
||
|
||
Se actualizaron los `__manifest__.py` de 3 addons para incluir el campo `maintainers`:
|
||
|
||
- product_pricelist_total_margin
|
||
- product_price_category_supplier
|
||
- account_invoice_triple_discount_readonly
|
||
|
||
Todos ahora tienen:
|
||
```python
|
||
"author": "Odoo Community Association (OCA), Criptomart",
|
||
"maintainers": ["Criptomart"],
|
||
```
|
||
|
||
## Archivos README_DEV.md
|
||
|
||
Los README.md originales han sido renombrados a README_DEV.md para mantenerlos como referencia técnica de desarrollo sin interferir con la documentación oficial OCA. Estos archivos contienen:
|
||
|
||
- Información técnica detallada
|
||
- Notas de implementación
|
||
- Ejemplos de código
|
||
- Detalles de arquitectura
|
||
|
||
## Verificación de Créditos
|
||
|
||
✅ **Todos los addons incluyen correctamente**:
|
||
|
||
| Addon | Criptomart | Elika Bilbo |
|
||
|-------|-----------|-------------|
|
||
| website_sale_aplicoop | ✓ | ✓ |
|
||
| product_sale_price_from_pricelist | ✓ | ✓ |
|
||
| product_pricelist_total_margin | ✓ | ✓ |
|
||
| product_price_category_supplier | ✓ | ✓ |
|
||
| account_invoice_triple_discount_readonly | ✓ | ✓ |
|
||
|
||
## Formato de Créditos en README.rst
|
||
|
||
Todos los README.rst siguen este formato estándar:
|
||
|
||
```rst
|
||
Credits
|
||
=======
|
||
|
||
Authors
|
||
~~~~~~~
|
||
|
||
* Criptomart
|
||
|
||
Funding
|
||
~~~~~~~
|
||
|
||
* Elika Bilbo
|
||
|
||
Contributors
|
||
~~~~~~~~~~~~
|
||
|
||
* `Criptomart <https://criptomart.net>`_:
|
||
|
||
* Specific contributions...
|
||
|
||
Other credits
|
||
~~~~~~~~~~~~~
|
||
|
||
Additional information about the module...
|
||
```
|
||
|
||
## Documentación Adicional Creada
|
||
|
||
Se ha creado el archivo `/docs/OCA_DOCUMENTATION.md` que contiene:
|
||
|
||
- Explicación de la nueva estructura de documentación
|
||
- Guía para mantener y actualizar la documentación
|
||
- Instrucciones para generar README.rst desde los fragmentos
|
||
- Referencias a los estándares OCA
|
||
- Ejemplos de uso de la herramienta oca-gen-addon-readme
|
||
|
||
## Referencias a Estándares OCA
|
||
|
||
La documentación sigue las guías oficiales de OCA:
|
||
|
||
- [OCA README Structure](https://odoo-community.org/readme-structure)
|
||
- [OCA README Guidelines](https://odoo-community.org/read-me-guidelines)
|
||
|
||
## Próximos Pasos (Opcional)
|
||
|
||
Para mantener la documentación actualizada:
|
||
|
||
1. **Al actualizar un addon**: Editar los fragmentos en `readme/`, no el README.rst directamente
|
||
2. **Regenerar README.rst**: Usar `oca-gen-addon-readme` si se instala correctamente
|
||
3. **Validar formato**: Usar pre-commit hooks para verificar formato RST
|
||
4. **Traducir**: Mantener traducciones de documentación según necesidad
|
||
|
||
## Archivos Modificados/Creados
|
||
|
||
**Total de archivos procesados**: 55+
|
||
|
||
- 5 × README.md → README_DEV.md (renombrados)
|
||
- 5 × README.rst (creados/actualizados)
|
||
- 30 × archivos .rst en directorios readme/ (6 por addon)
|
||
- 3 × __manifest__.py (actualizados)
|
||
- 2 × archivos de documentación (OCA_DOCUMENTATION.md, RESUMEN_CAMBIOS.md)
|
||
|
||
## Conclusión
|
||
|
||
✅ **Todos los addons custom ahora siguen los estándares OCA**
|
||
✅ **Créditos correctamente asignados**: Criptomart (autor) + Elika Bilbo (financiador)
|
||
✅ **Documentación para desarrolladores preservada** en README_DEV.md
|
||
✅ **Sistema de fragmentos listo** para mantenimiento futuro
|
||
✅ **Estructura compatible con herramientas OCA** como oca-gen-addon-readme
|
||
|
||
---
|
||
|
||
**Verificado el**: 21 Feb 2026
|
||
**Estado**: ✅ Completado exitosamente
|