CriptoMart/addons-cm
2
0
Fork 0
Code Issues 2 Pull requests Releases Wiki Activity

[DOC] Actualizar documentación a estándares OCA y preparar logo CriptoMart

Browse source 
- 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:
snt 2026-02-21 19:55:57 +01:00
parent b31df7b9d8
commit 4a4639f13a
56 changed files with 1778 additions and 674 deletions
Download patch file Download diff file Expand all files Collapse all files

108
docs/LOGO_INSTRUCTIONS.md Normal file
View file

@ -0,0 +1,108 @@
# CriptoMart Logo for Addons
## Quick Start
El logo de CriptoMart ha sido adjuntado en este proyecto. Para usarlo:
```bash
# 1. Guardar el logo adjunto como /tmp/criptomart_logo.png
# 2. Ejecutar este script:
cd /home/snt/Documentos/lab/odoo/addons-cm
for addon in website_sale_aplicoop product_sale_price_from_pricelist \
product_pricelist_total_margin product_price_category_supplier \
account_invoice_triple_discount_readonly; do
cp /tmp/criptomart_logo.png "$addon/static/description/icon.png"
echo "✓ Logo copied to $addon"
done
echo ""
echo "✅ Logo installation complete!"
echo "Restart Odoo and update apps list to see the changes."
```
## Logo Location
The CriptoMart logo should be placed in each custom addon at:
```
addon_name/static/description/icon.png
```
## Logo Requirements (Odoo Standard)
- **Format**: PNG
- **Recommended size**: 256x256 pixels (or 128x128)
- **Background**: Transparent or white
- **Format ratio**: Square (1:1)
## Current Logo
The CriptoMart logo features:
- A circular network/blockchain design at the top
- The text "CriptoMart" below
- A smile/arc at the bottom
- Black on transparent/white background
## Addons Requiring Logo
The following custom addons should have the CriptoMart logo:
1. ✓ website_sale_aplicoop
2. ✓ product_sale_price_from_pricelist
3. ✓ product_pricelist_total_margin
4. ✓ product_price_category_supplier
5. ✓ account_invoice_triple_discount_readonly
## How to Add the Logo
### Option 1: Manual Copy
```bash
# Copy logo to each addon
cp criptomart_logo.png website_sale_aplicoop/static/description/icon.png
cp criptomart_logo.png product_sale_price_from_pricelist/static/description/icon.png
cp criptomart_logo.png product_pricelist_total_margin/static/description/icon.png
cp criptomart_logo.png product_price_category_supplier/static/description/icon.png
cp criptomart_logo.png account_invoice_triple_discount_readonly/static/description/icon.png
```
### Option 2: Automated Script
```bash
# Save the logo as docs/criptomart_logo.png first, then:
cd /home/snt/Documentos/lab/odoo/addons-cm
for addon in website_sale_aplicoop product_sale_price_from_pricelist \
product_pricelist_total_margin product_price_category_supplier \
account_invoice_triple_discount_readonly; do
cp docs/criptomart_logo.png "$addon/static/description/icon.png"
echo "✓ Logo copied to $addon"
done
```
## Verification
After adding the logo, verify it appears correctly:
1. Restart Odoo
2. Update the app list
3. Search for the addon
4. The CriptoMart logo should appear in the addon tile
## Logo Source
The logo file is attached in the project documentation and should be saved as:
- `docs/criptomart_logo.png` (for reference and distribution)
## Notes
- The logo will appear in the Odoo Apps list
- It identifies the addon as developed by CriptoMart
- It provides visual consistency across all custom addons
- The logo is particularly visible in the Apps menu and module information pages
## Copyright
Logo © CriptoMart - All rights reserved

87
docs/LOGO_PENDING.md Normal file
View file

@ -0,0 +1,87 @@
# Logo de CriptoMart - Instalación Pendiente
## 🎨 Estado Actual
Se ha preparado la estructura para incluir el logo de CriptoMart en todos los addons custom:
✅ **Completado:**
- Directorios `static/description/` creados en los 5 addons
- Script de instalación automática creado ([docs/install_logo.sh](install_logo.sh))
- Documentación actualizada:
- [docs/LOGO_INSTRUCTIONS.md](LOGO_INSTRUCTIONS.md) - Instrucciones detalladas
- [docs/OCA_DOCUMENTATION.md](OCA_DOCUMENTATION.md#logo-de-criptomart) - Sección de logo
- [.github/copilot-instructions.md](../.github/copilot-instructions.md) - Referencias actualizadas
⏳ **Pendiente:**
- Guardar el logo adjunto en el sistema de archivos
- Ejecutar el script de instalación
## 📋 Pasos para Completar la Instalación
### Opción 1: Instalación Automática (Recomendada)
```bash
# 1. Guardar el logo adjuntado como /tmp/criptomart_logo.png
# (Descarga/copia la imagen adjunta en el mensaje)
# 2. Ejecutar el script de instalación
cd /home/snt/Documentos/lab/odoo/addons-cm
bash docs/install_logo.sh
# 3. Reiniciar Odoo
docker-compose restart odoo
# 4. Actualizar lista de apps en Odoo
# Settings → Apps → Update Apps List
```
### Opción 2: Instalación Manual
```bash
# 1. Guardar el logo adjuntado como /tmp/criptomart_logo.png
# 2. Copiar a cada addon manualmente
cd /home/snt/Documentos/lab/odoo/addons-cm
cp /tmp/criptomart_logo.png website_sale_aplicoop/static/description/icon.png
cp /tmp/criptomart_logo.png product_sale_price_from_pricelist/static/description/icon.png
cp /tmp/criptomart_logo.png product_pricelist_total_margin/static/description/icon.png
cp /tmp/criptomart_logo.png product_price_category_supplier/static/description/icon.png
cp /tmp/criptomart_logo.png account_invoice_triple_discount_readonly/static/description/icon.png
# 3. Reiniciar Odoo
docker-compose restart odoo
```
## 📁 Addons que Recibirán el Logo
1. ✅ website_sale_aplicoop
2. ✅ product_sale_price_from_pricelist
3. ✅ product_pricelist_total_margin
4. ✅ product_price_category_supplier
5. ✅ account_invoice_triple_discount_readonly
## ✨ Resultado Esperado
Después de la instalación, el logo de CriptoMart aparecerá:
- En la lista de Apps de Odoo (vista de cuadrícula)
- En las páginas de información de cada módulo
- En la documentación visual del proyecto
## 📝 Especificaciones del Logo
- **Formato:** PNG
- **Tamaño:** 256x256 px (recomendado) o 128x128 px
- **Fondo:** Transparente o blanco
- **Contenido:** Logo de CriptoMart con diseño de red/blockchain
## 🔗 Referencias
- [Instrucciones completas de logo](LOGO_INSTRUCTIONS.md)
- [Documentación OCA](OCA_DOCUMENTATION.md)
- [Script de instalación](install_logo.sh)
---
**Nota:** El logo adjuntado en el mensaje debe ser guardado primero en el sistema de archivos antes de ejecutar el script de instalación.

175
docs/OCA_DOCUMENTATION.md Normal file
View file

@ -0,0 +1,175 @@
# OCA Documentation Structure
## Overview
Los addons custom del proyecto ahora siguen los **estándares OCA** para documentación, usando el directorio `/readme` con fragmentos `.rst` que se ensamblan automáticamente para generar el README final.
## Estructura de Directorios
Cada addon tiene la siguiente estructura de documentación:
```
addon_name/
├── __manifest__.py # Manifest con autor "Criptomart"
├── README.rst # README automático generado (OCA standard)
├── README_DEV.md # README para desarrolladores (ex-README.md)
├── readme/ # Fragmentos para generar 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 y financiadores
└── static/
└── description/
└── icon.png # Logo de CriptoMart (256x256 px)
```
## Addons Actualizados
Los siguientes addons custom han sido actualizados con la estructura OCA:
1. **website_sale_aplicoop** - Sistema de pedidos grupales (eskaera)
2. **product_sale_price_from_pricelist** - Auto-cálculo de precios de venta
3. **product_pricelist_total_margin** - Márgenes aditivos en pricelists
4. **product_price_category_supplier** - Categorías de precio por proveedor
5. **account_invoice_triple_discount_readonly** - Fix para triple descuento
## Créditos en Documentación
Todos los addons incluyen correctamente:
- **Autor**: Criptomart (en `__manifest__.py` y `README.rst`)
- **Financiador**: Elika Bilbo (en `readme/CREDITS.rst`)
## Logo de CriptoMart
Todos los addons custom deben incluir el logo de CriptoMart en:
```
addon_name/static/description/icon.png
```
**Especificaciones del logo:**
- Formato: PNG
- Tamaño recomendado: 256x256 px (o 128x128 px)
- Fondo: Transparente o blanco
- Ratio: Cuadrado (1:1)
**Para instalar el logo:**
Ver instrucciones detalladas en [docs/LOGO_INSTRUCTIONS.md](LOGO_INSTRUCTIONS.md).
Script rápido:
```bash
# 1. Guardar logo adjunto como /tmp/criptomart_logo.png
# 2. Ejecutar:
bash docs/install_logo.sh
```
El logo aparecerá en la lista de Apps de Odoo y en las páginas de información del módulo.
## Generación Automática del README
Para generar automáticamente el `README.rst` desde los fragmentos, usa la herramienta OCA:
```bash
# Instalar oca-gen-addon-readme
pip install oca-gen-addon-readme
# Generar README para un addon
cd addon_name/
oca-gen-addon-readme
# O generar para todos los addons
for addon in website_sale_aplicoop product_*; do
cd "$addon" && oca-gen-addon-readme && cd ..
done
```
## Fragmentos del Directorio readme/
### DESCRIPTION.rst (Obligatorio)
Descripción breve del módulo y sus funcionalidades principales. Se muestra al inicio del README.
### INSTALL.rst (Opcional)
Instrucciones específicas de instalación si el módulo requiere pasos adicionales al proceso estándar.
### CONFIGURE.rst (Opcional)
Pasos de configuración necesarios después de instalar el módulo.
### USAGE.rst (Obligatorio)
Guía de uso del módulo con ejemplos prácticos y flujos de trabajo.
### CONTRIBUTORS.rst (Obligatorio)
Lista de personas y organizaciones que han contribuido al desarrollo.
Formato:
```rst
* `Criptomart <https://criptomart.net>`_:
* Role/contribution description
```
### CREDITS.rst (Obligatorio)
Información sobre autores, financiadores y otros créditos.
Formato estándar:
```rst
**Authors:**
* Criptomart
**Funding:**
* Elika Bilbo
**Other credits:**
Additional information about the module development.
```
## README_DEV.md
Los archivos `README.md` originales han sido renombrados a `README_DEV.md` para mantenerlos como referencia de desarrollo sin que interfieran 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
## Referencias
- [OCA README Structure](https://odoo-community.org/readme-structure)
- [OCA README Guidelines](https://odoo-community.org/read-me-guidelines)
- [oca-gen-addon-readme Tool](https://pypi.org/project/oca-gen-addon-readme/)
## Mantenimiento
Al actualizar un addon:
1. Actualiza los fragmentos en `readme/` según corresponda
2. NO edites directamente `README.rst` (se sobrescribirá)
3. Usa `README_DEV.md` para notas técnicas de desarrollo
4. Regenera `README.rst` con `oca-gen-addon-readme`
5. Actualiza `__manifest__.py` version cuando hagas cambios significativos
## Validación
Para verificar que la documentación cumple con los estándares OCA:
```bash
# Instalar herramientas de validación OCA
pip install pre-commit
# Ejecutar validación
pre-commit run --all-files
```

190
docs/RESUMEN_CAMBIOS_DOCUMENTACION.md Normal file
View file

@ -0,0 +1,190 @@
# 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

56
docs/install_logo.sh Executable file
View file

@ -0,0 +1,56 @@
#!/bin/bash
# Script para instalar el logo de CriptoMart en todos los addons custom
#
# Uso:
# 1. Guardar el logo adjunto como /tmp/criptomart_logo.png
# (Descarga el logo desde el mensaje/attachment)
# 2. Ejecutar: bash docs/install_logo.sh
set -e
LOGO_SOURCE="/home/snt/Documentos/lab/odoo/addons-cm/website_sale_aplicoop/static/description/logo_criptomart_cuadradado_white_background.png"
ADDtaONS=(
"website_sale_aplicoop"
"product_sale_price_from_pricelist"
"product_pricelist_total_margin"
"product_price_category_supplier"
"account_invoice_triple_discount_readonly"
)
# Verificar que el logo existe
if [ ! -f "$LOGO_SOURCE" ]; then
echo "❌ Error: Logo no encontrado en $LOGO_SOURCE"
echo ""
echo "Por favor:"
echo "1. Descarga el logo adjunto de CriptoMart"
echo "2. Guárdalo como: $LOGO_SOURCE"
echo "3. Ejecuta este script de nuevo"
exit 1
fi
echo "🎨 Instalando logo de CriptoMart en addons..."
echo ""
# Copiar logo a cada addon
for addon in "${ADDONS[@]}"; do
if [ -d "$addon" ]; then
# Crear directorio si no existe
mkdir -p "$addon/static/description"
# Copiar logo
cp "$LOGO_SOURCE" "$addon/static/description/icon.png"
echo "✅ $addon"
else
echo "⚠️ $addon (directorio no encontrado)"
fi
done
echo ""
echo "✅ Logo instalado exitosamente en ${#ADDONS[@]} addons!"
echo ""
echo "Próximos pasos:"
echo "1. Reiniciar Odoo: docker-compose restart odoo"
echo "2. Actualizar lista de apps: Settings → Apps → Update Apps List"
echo "3. Verificar que el logo aparece en cada addon"