From 72074b53e54adea84328dd1863acd9339b451812 Mon Sep 17 00:00:00 2001 From: Miguel Guevara Date: Sat, 13 Dec 2025 14:47:21 -0400 Subject: [PATCH] fix(docs): correct broken links and TOC anchors in multilingual documentation Fixes #7 - Fix mkdocs.yml navigation structure pointing to non-existent paths - Fix 47 broken TOC anchor links (removed accents, fixed triple-dashes) - Fix cross-reference links in installation, getting-started, and examples - Fix decorators link format across client.md files - Remove non-existent TOC entries from decorators.de.md - Add v1.0.21 changelog entry in EN/ES/DE --- docs/changelog.de.md | 25 +++++++++++++- docs/changelog.es.md | 25 +++++++++++++- docs/changelog.md | 25 +++++++++++++- docs/examples/advanced.de.md | 4 +-- docs/examples/advanced.es.md | 14 ++++---- docs/examples/basic.de.md | 14 ++++---- docs/examples/basic.es.md | 12 +++---- docs/examples/relations.de.md | 2 +- docs/examples/relations.es.md | 8 ++--- docs/examples/relations.md | 4 +-- docs/getting-started.de.md | 4 +-- docs/getting-started.es.md | 4 +-- docs/getting-started.md | 4 +-- docs/index.de.md | 11 ++++-- docs/index.es.md | 11 ++++-- docs/installation.de.md | 6 ++-- docs/installation.es.md | 16 ++++----- docs/installation.md | 2 +- docs/references/client.de.md | 2 +- docs/references/client.es.md | 2 +- docs/references/client.md | 2 +- docs/references/core-concepts.de.md | 4 +-- docs/references/core-concepts.es.md | 4 +-- docs/references/decorators.de.md | 22 +++++------- docs/references/decorators.es.md | 34 +++++++++---------- docs/references/decorators.md | 34 +++++++++---------- docs/references/migration.es.md | 8 ++--- mkdocs.yml | 52 +++++++++++------------------ 28 files changed, 209 insertions(+), 146 deletions(-) diff --git a/docs/changelog.de.md b/docs/changelog.de.md index 14174e8..82f18d7 100644 --- a/docs/changelog.de.md +++ b/docs/changelog.de.md @@ -14,6 +14,28 @@ und dieses Projekt hält sich an [Semantische Versionierung](https://semver.org/ --- +## [1.0.21] - 2025-12-13 + +### Behoben +- **mkdocs.yml**: Navigationsstruktur korrigiert, die auf nicht existierende Pfade verwies (`guides/`, `api/`) +- **TOC-Anker**: 47 defekte Ankerlinks in ES/DE-Dokumentationsdateien behoben + - Akzente aus Ankern entfernt (`#introducción` → `#introduccion`) + - Dreifach-Strich-Anker korrigiert (`#primarykey---claves` → `#primarykey-claves`) +- **docs/index.es.md, docs/index.de.md**: Startseiten-Links auf korrekte Pfade korrigiert +- **docs/installation.*.md**: API-Referenzlinks korrigiert (`./api/table.md` → `./references/table.md`) +- **docs/getting-started.*.md**: Core-Concepts- und Beispiel-Links korrigiert +- **docs/references/client.*.md**: Decorators-Linkformat korrigiert (`./decorators/` → `./decorators.md`) +- **docs/references/decorators.de.md**: TOC-Einträge für nicht existierende Abschnitte entfernt (Datei unvollständig) +- **docs/examples/relations.*.md**: Decorator-Referenzlinks auf korrekte Anker korrigiert +- **docs/examples/advanced.*.md**: Core-Concepts-Querverweislink korrigiert + +### Dokumentation +- Alle MkDocs-Build-Warnungen behoben (von 47 auf 0 defekte Links) +- Mehrsprachige Dokumentationskonsistenz verbessert (EN/ES/DE) +- Deutsche Navigationsleiste auf 404-Seiten aufgrund falscher Linkpfade behoben + +--- + ## [1.0.20] - 2025-12-12 ### Hinzugefügt @@ -184,7 +206,8 @@ Dies ist eine stabile Version von @arcaelas/dynamite - ein modernes, Decorator-f ## Versionsverlauf-Zusammenfassung -- **v1.0.20** (Aktuell) - Dokumentationsumstrukturierung, Codebasis-Optimierung, API.md-Erstellung +- **v1.0.21** (Aktuell) - Dokumentationslink-Korrekturen, TOC-Anker-Korrekturen, mehrsprachige Konsistenz +- **v1.0.20** - Dokumentationsumstrukturierung, Codebasis-Optimierung, API.md-Erstellung - **v1.0.17** - @Serialize, @DeleteAt, Dynamite.tx()-Transaktionen hinzugefügt - **v1.0.13** - Stabile Version mit vollständigem Funktionsumfang - **v1.0.0** - Erste öffentliche Veröffentlichung diff --git a/docs/changelog.es.md b/docs/changelog.es.md index fc4bec3..86bd114 100644 --- a/docs/changelog.es.md +++ b/docs/changelog.es.md @@ -14,6 +14,28 @@ y este proyecto adhiere a [Versionado Semántico](https://semver.org/spec/v2.0.0 --- +## [1.0.21] - 2025-12-13 + +### Corregido +- **mkdocs.yml**: Corregida la estructura de navegación que apuntaba a rutas inexistentes (`guides/`, `api/`) +- **Anclas TOC**: Corregidos 47 enlaces de anclas rotos en archivos de documentación ES/DE + - Eliminados acentos de anclas (`#introducción` → `#introduccion`) + - Corregidos anclas con triple guión (`#primarykey---claves` → `#primarykey-claves`) +- **docs/index.es.md, docs/index.de.md**: Corregidos enlaces de página de inicio a rutas correctas +- **docs/installation.*.md**: Corregidos enlaces de referencia API (`./api/table.md` → `./references/table.md`) +- **docs/getting-started.*.md**: Corregidos enlaces de core-concepts y ejemplos +- **docs/references/client.*.md**: Corregido formato de enlace de decoradores (`./decorators/` → `./decorators.md`) +- **docs/references/decorators.de.md**: Eliminadas entradas TOC para secciones inexistentes (archivo incompleto) +- **docs/examples/relations.*.md**: Corregidos enlaces de referencia de decoradores a anclas correctas +- **docs/examples/advanced.*.md**: Corregido enlace de referencia cruzada de core-concepts + +### Documentación +- Resueltas todas las advertencias de compilación de MkDocs (de 47 a 0 enlaces rotos) +- Mejorada la consistencia de documentación multilingüe (EN/ES/DE) +- Corregida la barra de navegación alemana que aparecía en páginas 404 debido a rutas de enlaces incorrectas + +--- + ## [1.0.20] - 2025-12-12 ### Agregado @@ -184,7 +206,8 @@ Esta es una versión estable de @arcaelas/dynamite - un ORM moderno basado en de ## Resumen del Historial de Versiones -- **v1.0.20** (Actual) - Reestructuración de documentación, optimización del código base, creación de API.md +- **v1.0.21** (Actual) - Corrección de enlaces de documentación, anclas TOC, consistencia multilingüe +- **v1.0.20** - Reestructuración de documentación, optimización del código base, creación de API.md - **v1.0.17** - Agregado @Serialize, @DeleteAt, transacciones Dynamite.tx() - **v1.0.13** - Versión estable con conjunto completo de características - **v1.0.0** - Versión pública inicial diff --git a/docs/changelog.md b/docs/changelog.md index a84ba19..cf3ac36 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -14,6 +14,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 --- +## [1.0.21] - 2025-12-13 + +### Fixed +- **mkdocs.yml**: Corrected navigation structure pointing to non-existent paths (`guides/`, `api/`) +- **TOC anchors**: Fixed 47 broken anchor links across ES/DE documentation files + - Removed accents from anchors (`#introducción` → `#introduccion`) + - Fixed triple-dash anchors (`#primarykey---claves` → `#primarykey-claves`) +- **docs/index.es.md, docs/index.de.md**: Fixed homepage links to correct paths +- **docs/installation.*.md**: Fixed API reference links (`./api/table.md` → `./references/table.md`) +- **docs/getting-started.*.md**: Fixed core-concepts and examples links +- **docs/references/client.*.md**: Fixed decorators link format (`./decorators/` → `./decorators.md`) +- **docs/references/decorators.de.md**: Removed TOC entries for non-existent sections (file is incomplete) +- **docs/examples/relations.*.md**: Fixed decorator reference links to correct anchors +- **docs/examples/advanced.*.md**: Fixed core-concepts cross-reference link + +### Documentation +- Resolved all MkDocs build warnings (from 47 to 0 broken links) +- Improved multilingual documentation consistency (EN/ES/DE) +- Fixed German navbar appearing on 404 pages due to incorrect link paths + +--- + ## [1.0.20] - 2025-12-12 ### Added @@ -184,7 +206,8 @@ This is a stable release of @arcaelas/dynamite - a modern, decorator-first ORM f ## Version History Summary -- **v1.0.20** (Current) - Documentation restructure, codebase optimization, API.md creation +- **v1.0.21** (Current) - Documentation link fixes, TOC anchor corrections, multilingual consistency +- **v1.0.20** - Documentation restructure, codebase optimization, API.md creation - **v1.0.17** - Added @Serialize, @DeleteAt, Dynamite.tx() transactions - **v1.0.13** - Stable release with full feature set - **v1.0.0** - Initial public release diff --git a/docs/examples/advanced.de.md b/docs/examples/advanced.de.md index e9941dc..2799aa1 100644 --- a/docs/examples/advanced.de.md +++ b/docs/examples/advanced.de.md @@ -12,7 +12,7 @@ Dieses umfassende Beispiel demonstriert fortgeschrittene Abfragemuster, Paginier - [Sortierung und Reihenfolge](#sortierung-und-reihenfolge) - [Attributauswahl](#attributauswahl) - [Komplexe Filterung](#komplexe-filterung) -- [Vollständiges Funktionierendes Beispiel](#vollständiges-funktionierendes-beispiel) +- [Vollstandiges Funktionierendes Beispiel](#vollstandiges-funktionierendes-beispiel) - [Erwartete Ausgabe](#erwartete-ausgabe) - [Leistungsoptimierung](#leistungsoptimierung) - [Best Practices](#best-practices) @@ -866,7 +866,7 @@ async function get_users_1() { ### API-Referenzen - [Table API](../references/table.md) - Vollständige Table-Klassendokumentation -- [Abfrageoperatoren](../references/core-concepts.md#query-operators) - Alle verfügbaren Operatoren +- [Abfrageoperatoren](../references/core-concepts.de.md#query-operatoren) - Alle verfügbaren Operatoren - [Decorator-Leitfaden](../references/decorators.md) - Alle verfügbaren Decorators Viel Erfolg beim Abfragen mit Dynamite! diff --git a/docs/examples/advanced.es.md b/docs/examples/advanced.es.md index 62d5851..7c0dbb5 100644 --- a/docs/examples/advanced.es.md +++ b/docs/examples/advanced.es.md @@ -5,17 +5,17 @@ Este ejemplo completo demuestra patrones de consulta avanzados, paginación, fil ## Tabla de Contenidos - [Operadores de Consulta](#operadores-de-consulta) -- [Consultas de Comparación](#consultas-de-comparación) +- [Consultas de Comparacion](#consultas-de-comparacion) - [Consultas de Array](#consultas-de-array) - [Consultas de String](#consultas-de-string) -- [Paginación](#paginación) -- [Ordenamiento y Clasificación](#ordenamiento-y-clasificación) -- [Selección de Atributos](#selección-de-atributos) +- [Paginacion](#paginacion) +- [Ordenamiento y Clasificacion](#ordenamiento-y-clasificacion) +- [Seleccion de Atributos](#seleccion-de-atributos) - [Filtrado Complejo](#filtrado-complejo) - [Ejemplo Completo Funcional](#ejemplo-completo-funcional) - [Salida Esperada](#salida-esperada) -- [Optimización de Rendimiento](#optimización-de-rendimiento) -- [Mejores Prácticas](#mejores-prácticas) +- [Optimizacion de Rendimiento](#optimizacion-de-rendimiento) +- [Mejores Practicas](#mejores-practicas) ## Operadores de Consulta @@ -1060,7 +1060,7 @@ async function get_users_1() { ### Referencias de API - [API de Table](../references/table.md) - Documentación completa de la clase Table -- [Operadores de Consulta](../references/core-concepts.md#query-operators) - Todos los operadores disponibles +- [Operadores de Consulta](../references/core-concepts.es.md#operadores-de-consulta) - Todos los operadores disponibles - [Guía de Decoradores](../references/decorators.md) - Todos los decoradores disponibles ¡Feliz consulta con Dynamite! diff --git a/docs/examples/basic.de.md b/docs/examples/basic.de.md index 7b5e041..aba5b51 100644 --- a/docs/examples/basic.de.md +++ b/docs/examples/basic.de.md @@ -6,14 +6,14 @@ Dieses Beispiel demonstriert eine einfache CRUD-Anwendung (Create, Read, Update, - [Modelldefinition](#modelldefinition) - [Einrichtung und Konfiguration](#einrichtung-und-konfiguration) -- [Datensätze Erstellen](#datensätze-erstellen) -- [Datensätze Lesen](#datensätze-lesen) -- [Datensätze Aktualisieren](#datensätze-aktualisieren) -- [Datensätze Löschen](#datensätze-löschen) -- [Vollständiges Funktionierendes Beispiel](#vollständiges-funktionierendes-beispiel) +- [Datensatze Erstellen](#datensatze-erstellen) +- [Datensatze Lesen](#datensatze-lesen) +- [Datensatze Aktualisieren](#datensatze-aktualisieren) +- [Datensatze Loschen](#datensatze-loschen) +- [Vollstandiges Funktionierendes Beispiel](#vollstandiges-funktionierendes-beispiel) - [Erwartete Ausgabe](#erwartete-ausgabe) -- [Schlüsselkonzepte](#schlüsselkonzepte) -- [Nächste Schritte](#nächste-schritte) +- [Schlusselkonzepte](#schlusselkonzepte) +- [Nachste Schritte](#nachste-schritte) ## Modelldefinition diff --git a/docs/examples/basic.es.md b/docs/examples/basic.es.md index 18d88d8..19749f9 100644 --- a/docs/examples/basic.es.md +++ b/docs/examples/basic.es.md @@ -4,16 +4,16 @@ Este ejemplo demuestra una aplicación CRUD (Crear, Leer, Actualizar, Eliminar) ## Tabla de Contenidos -- [Definición del Modelo](#definición-del-modelo) -- [Configuración e Inicialización](#configuración-e-inicialización) -- [Creación de Registros](#creación-de-registros) +- [Definicion del Modelo](#definicion-del-modelo) +- [Configuracion e Inicializacion](#configuracion-e-inicializacion) +- [Creacion de Registros](#creacion-de-registros) - [Lectura de Registros](#lectura-de-registros) -- [Actualización de Registros](#actualización-de-registros) -- [Eliminación de Registros](#eliminación-de-registros) +- [Actualizacion de Registros](#actualizacion-de-registros) +- [Eliminacion de Registros](#eliminacion-de-registros) - [Ejemplo Completo Funcional](#ejemplo-completo-funcional) - [Salida Esperada](#salida-esperada) - [Conceptos Clave](#conceptos-clave) -- [Próximos Pasos](#próximos-pasos) +- [Proximos Pasos](#proximos-pasos) ## Definición del Modelo diff --git a/docs/examples/relations.de.md b/docs/examples/relations.de.md index 66553ae..4e2ab21 100644 --- a/docs/examples/relations.de.md +++ b/docs/examples/relations.de.md @@ -9,7 +9,7 @@ Dieses umfassende Beispiel demonstriert, wie Sie Beziehungen in Dynamite ORM def - [Viele-zu-Eins (BelongsTo)](#viele-zu-eins-belongsto) - [Verschachtelte Beziehungen](#verschachtelte-beziehungen) - [Gefilterte Beziehungen](#gefilterte-beziehungen) -- [Vollständiges E-Commerce-Beispiel](#vollständiges-e-commerce-beispiel) +- [Vollstandiges E-Commerce-Beispiel](#vollstandiges-e-commerce-beispiel) - [Erwartete Ausgabe](#erwartete-ausgabe) - [Erweiterte Muster](#erweiterte-muster) - [Best Practices](#best-practices) diff --git a/docs/examples/relations.es.md b/docs/examples/relations.es.md index 7fd2599..d11d265 100644 --- a/docs/examples/relations.es.md +++ b/docs/examples/relations.es.md @@ -4,7 +4,7 @@ Este ejemplo completo demuestra cómo definir y usar relaciones en Dynamite ORM. ## Tabla de Contenidos -- [Conceptos Básicos de Relaciones](#conceptos-básicos-de-relaciones) +- [Conceptos Basicos de Relaciones](#conceptos-basicos-de-relaciones) - [Uno-a-Muchos (HasMany)](#uno-a-muchos-hasmany) - [Muchos-a-Uno (BelongsTo)](#muchos-a-uno-belongsto) - [Relaciones Anidadas](#relaciones-anidadas) @@ -12,7 +12,7 @@ Este ejemplo completo demuestra cómo definir y usar relaciones en Dynamite ORM. - [Ejemplo Completo de E-Commerce](#ejemplo-completo-de-e-commerce) - [Salida Esperada](#salida-esperada) - [Patrones Avanzados](#patrones-avanzados) -- [Mejores Prácticas](#mejores-prácticas) +- [Mejores Practicas](#mejores-practicas) ## Conceptos Básicos de Relaciones @@ -1059,8 +1059,8 @@ for (const post of posts) { ### Referencias de API -- [Decorador HasMany](../references/decorators.md#hasmany) - Documentación completa de HasMany -- [Decorador BelongsTo](../references/decorators.md#belongsto) - Documentación completa de BelongsTo +- [Decorador HasMany](../references/decorators.md#hasmany-relaciones-uno-a-muchos) - Documentación completa de HasMany +- [Decorador BelongsTo](../references/decorators.md#belongsto-relaciones-muchos-a-uno) - Documentación completa de BelongsTo - [Consultas Avanzadas](./advanced.es.md) - Consultas complejas con relaciones ¡Feliz codificación con relaciones de Dynamite! diff --git a/docs/examples/relations.md b/docs/examples/relations.md index a1562c1..3127d02 100644 --- a/docs/examples/relations.md +++ b/docs/examples/relations.md @@ -1059,8 +1059,8 @@ for (const post of posts) { ### API References -- [HasMany Decorator](../references/decorators.md#hasmany) - Complete HasMany documentation -- [BelongsTo Decorator](../references/decorators.md#belongsto) - Complete BelongsTo documentation +- [HasMany Decorator](../references/decorators.md#hasmany-relaciones-uno-a-muchos) - Complete HasMany documentation +- [BelongsTo Decorator](../references/decorators.md#belongsto-relaciones-muchos-a-uno) - Complete BelongsTo documentation - [Advanced Queries](./advanced.md) - Complex queries with relationships ### Additional Topics diff --git a/docs/getting-started.de.md b/docs/getting-started.de.md index 8553a4b..86e7591 100644 --- a/docs/getting-started.de.md +++ b/docs/getting-started.de.md @@ -507,7 +507,7 @@ Jetzt, da Sie die Grundlagen verstehen, erkunden Sie diese erweiterten Themen: ### Kernkonzepte Lernen Sie die grundlegenden Konzepte und Architektur kennen: -- [Kernkonzepte](./core-concepts.de.md) - Tiefer Einblick in Decorators, Modelle und Beziehungen +- [Kernkonzepte](./references/core-concepts.de.md) - Tiefer Einblick in Decorators, Modelle und Beziehungen ### Erweiterte Funktionen - **Beziehungen** - Definieren Sie Eins-zu-Viele- und Viele-zu-Eins-Beziehungen @@ -526,7 +526,7 @@ Lernen Sie die grundlegenden Konzepte und Architektur kennen: ### Zusätzliche Ressourcen - [API-Referenz](references/table.md) - Vollständige API-Dokumentation -- [Beispiele](../../examples/) - Weitere Codebeispiele +- [Beispiele](./examples/basic.md) - Weitere Codebeispiele - [GitHub Issues](https://github.com/arcaelas/dynamite/issues) - Häufige Probleme und Lösungen ## Schnellreferenz diff --git a/docs/getting-started.es.md b/docs/getting-started.es.md index 6baface..747b378 100644 --- a/docs/getting-started.es.md +++ b/docs/getting-started.es.md @@ -613,7 +613,7 @@ Ahora que comprendes los conceptos básicos, explora estos temas avanzados: ### Conceptos Básicos Aprende sobre los conceptos fundamentales y la arquitectura: -- [Conceptos Básicos](./core-concepts.es.md) - Inmersión profunda en decoradores, modelos y relaciones +- [Conceptos Básicos](./references/core-concepts.es.md) - Inmersión profunda en decoradores, modelos y relaciones ### Características Avanzadas - **Relaciones** - Define relaciones uno a muchos y muchos a uno @@ -632,7 +632,7 @@ Aprende sobre los conceptos fundamentales y la arquitectura: ### Recursos Adicionales - [Referencia de API](references/table.md) - Documentación completa de la API -- [Ejemplos](../../examples/) - Más ejemplos de código +- [Ejemplos](./examples/basic.md) - Más ejemplos de código - [GitHub Issues](https://github.com/arcaelas/dynamite/issues) - Problemas comunes y soluciones ## Referencia Rápida diff --git a/docs/getting-started.md b/docs/getting-started.md index c49183f..6a2b595 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -613,7 +613,7 @@ Now that you understand the basics, explore these advanced topics: ### Core Concepts Learn about the fundamental concepts and architecture: -- [Core Concepts](./core-concepts.md) - Deep dive into decorators, models, and relationships +- [Core Concepts](./references/core-concepts.md) - Deep dive into decorators, models, and relationships ### Advanced Features - **Relationships** - Define one-to-many and many-to-one relationships @@ -632,7 +632,7 @@ Learn about the fundamental concepts and architecture: ### Additional Resources - [API Reference](references/table.md) - Complete API documentation -- [Examples](../../examples/) - More code examples +- [Examples](./examples/basic.md) - More code examples - [GitHub Issues](https://github.com/arcaelas/dynamite/issues) - Common issues and solutions ## Quick Reference diff --git a/docs/index.de.md b/docs/index.de.md index aba9153..0965da2 100644 --- a/docs/index.de.md +++ b/docs/index.de.md @@ -169,9 +169,14 @@ Dynamite basiert auf drei Kernkonzepten: ## Nächste Schritte - **[Installationsanleitung](installation.md)** - Richten Sie Dynamite in Ihrem Projekt ein -- **[Erste Schritte](guides/getting-started.md)** - Ihr erstes Dynamite-Modell -- **[Kernkonzepte](guides/core-concepts.md)** - Die Grundlagen verstehen -- **[API-Referenz](api/table.md)** - Vollständige API-Dokumentation +- **[Erste Schritte](getting-started.md)** - Ihr erstes Dynamite-Modell +- **[Kernkonzepte](references/core-concepts.md)** - Die Grundlagen verstehen +- **[API-Referenz](references/table.md)** - Vollständige API-Dokumentation +- **[Beispiele](examples/basic.md)** - Praktische Beispiele + - [Grundlegend](examples/basic.md) - CRUD-Operationen + - [Beziehungen](examples/relations.md) - HasMany, BelongsTo, ManyToMany + - [Fortgeschritten](examples/advanced.md) - Komplexe Abfragen und Muster +- **[Changelog](changelog.md)** - Versionshistorie ## Community diff --git a/docs/index.es.md b/docs/index.es.md index 0e1beeb..402cbcb 100644 --- a/docs/index.es.md +++ b/docs/index.es.md @@ -169,9 +169,14 @@ Dynamite está construido sobre tres conceptos fundamentales: ## Próximos Pasos - **[Guía de Instalación](installation.md)** - Configura Dynamite en tu proyecto -- **[Comenzando](guides/getting-started.md)** - Tu primer modelo Dynamite -- **[Conceptos Básicos](guides/core-concepts.md)** - Entendiendo los fundamentos -- **[Referencia API](api/table.md)** - Documentación completa de la API +- **[Comenzando](getting-started.md)** - Tu primer modelo Dynamite +- **[Conceptos Básicos](references/core-concepts.md)** - Entendiendo los fundamentos +- **[Referencia API](references/table.md)** - Documentación completa de la API +- **[Ejemplos](examples/basic.md)** - Ejemplos prácticos + - [Básico](examples/basic.md) - Operaciones CRUD + - [Relaciones](examples/relations.md) - HasMany, BelongsTo, ManyToMany + - [Avanzado](examples/advanced.md) - Consultas complejas y patrones +- **[Changelog](changelog.md)** - Historial de versiones ## Comunidad diff --git a/docs/installation.de.md b/docs/installation.de.md index e16f21d..0c65c85 100644 --- a/docs/installation.de.md +++ b/docs/installation.de.md @@ -12,9 +12,9 @@ Diese Anleitung deckt alles ab, was Sie benötigen, um @arcaelas/dynamite in Ihr - [Installation](#installation) - [AWS-Konfiguration](#aws-konfiguration) - [Basiskonfiguration](#basiskonfiguration) -- [Überprüfung](#überprüfung) +- [Uberprufung](#uberprufung) - [Fehlerbehebung](#fehlerbehebung) -- [Nächste Schritte](#nächste-schritte) +- [Nachste Schritte](#nachste-schritte) --- @@ -921,7 +921,7 @@ npm install @arcaelas/dynamite @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb ### Zusätzliche Ressourcen -- [API-Referenz](./api/table.md) +- [API-Referenz](./references/table.md) - [DynamoDB Best Practices](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/best-practices.html) - [AWS SDK v3-Dokumentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/) - [GitHub-Repository](https://github.com/arcaelas/dynamite) diff --git a/docs/installation.es.md b/docs/installation.es.md index 70840ee..ea71f26 100644 --- a/docs/installation.es.md +++ b/docs/installation.es.md @@ -9,12 +9,12 @@ Esta guía cubre todo lo que necesitas para instalar, configurar y verificar @ar ## Tabla de Contenidos - [Requisitos Previos](#requisitos-previos) -- [Instalación](#instalación) -- [Configuración de AWS](#configuración-de-aws) -- [Configuración Básica](#configuración-básica) -- [Verificación](#verificación) -- [Solución de Problemas](#solución-de-problemas) -- [Próximos Pasos](#próximos-pasos) +- [Instalacion](#instalacion) +- [Configuracion de AWS](#configuracion-de-aws) +- [Configuracion Basica](#configuracion-basica) +- [Verificacion](#verificacion) +- [Solucion de Problemas](#solucion-de-problemas) +- [Proximos Pasos](#proximos-pasos) --- @@ -921,7 +921,7 @@ npm install @arcaelas/dynamite @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb ### Recursos Adicionales -- [Referencia de API](./api/table.md) +- [Referencia de API](./references/table.md) - [Mejores Prácticas de DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/best-practices.html) - [Documentación AWS SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/) - [Repositorio GitHub](https://github.com/arcaelas/dynamite) @@ -937,7 +937,7 @@ npm install @arcaelas/dynamite @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb **¿Necesitas Ayuda?** Si encuentras algún problema no cubierto en esta guía, por favor: -1. Revisa la sección de [Solución de Problemas](#solución-de-problemas) arriba +1. Revisa la seccion de [Solucion de Problemas](#solucion-de-problemas) arriba 2. Abre un issue en [GitHub](https://github.com/arcaelas/dynamite/issues) --- diff --git a/docs/installation.md b/docs/installation.md index 02a373c..104d23c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -921,7 +921,7 @@ npm install @arcaelas/dynamite @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb ### Additional Resources -- [API Reference](./api/table.md) +- [API Reference](./references/table.md) - [DynamoDB Best Practices](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/best-practices.html) - [AWS SDK v3 Documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/) - [GitHub Repository](https://github.com/arcaelas/dynamite) diff --git a/docs/references/client.de.md b/docs/references/client.de.md index db2e82e..e6f19d5 100644 --- a/docs/references/client.de.md +++ b/docs/references/client.de.md @@ -1052,6 +1052,6 @@ export async function teardown_test_database(client: Dynamite) { ## Siehe auch - [Table API-Referenz](./table.md) - Vollständige Table-Klassendokumentation -- [Decorator-Referenz](./decorators/) - Alle verfügbaren Decorators +- [Decorator-Referenz](./decorators.md) - Alle verfügbaren Decorators - [AWS SDK DynamoDB-Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/) - Zugrundeliegende AWS SDK-Dokumentation - [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) - Lokale Entwicklungseinrichtung diff --git a/docs/references/client.es.md b/docs/references/client.es.md index 3e9b798..1941cca 100644 --- a/docs/references/client.es.md +++ b/docs/references/client.es.md @@ -1052,6 +1052,6 @@ export async function teardown_test_database(client: Dynamite) { ## Ver También - [Referencia de API Table](./table.md) - Documentación completa de la clase Table -- [Referencia de Decoradores](./decorators/) - Todos los decoradores disponibles +- [Referencia de Decoradores](./decorators.md) - Todos los decoradores disponibles - [Cliente DynamoDB del SDK de AWS](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/) - Documentación del SDK de AWS subyacente - [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) - Configuración de desarrollo local diff --git a/docs/references/client.md b/docs/references/client.md index 5665fd0..029d05c 100644 --- a/docs/references/client.md +++ b/docs/references/client.md @@ -1052,6 +1052,6 @@ export async function teardown_test_database(client: Dynamite) { ## See Also - [Table API Reference](./table.md) - Complete Table class documentation -- [Decorators Reference](./decorators/) - All available decorators +- [Decorators Reference](./decorators.md) - All available decorators - [AWS SDK DynamoDB Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/) - Underlying AWS SDK documentation - [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) - Local development setup diff --git a/docs/references/core-concepts.de.md b/docs/references/core-concepts.de.md index 0f35d32..02a8dc3 100644 --- a/docs/references/core-concepts.de.md +++ b/docs/references/core-concepts.de.md @@ -5,8 +5,8 @@ Dieser Leitfaden erklärt die grundlegenden Konzepte von Dynamite ORM und wie si ## Inhaltsverzeichnis 1. [Table-Klasse](#table-klasse) -2. [Decorators-Übersicht](#decorators-übersicht) -3. [Primärschlüssel](#primärschlüssel) +2. [Decorators-Ubersicht](#decorators-ubersicht) +3. [Primarschlussel](#primarschlussel) 4. [Indizes](#indizes) 5. [Query Builder](#query-builder) 6. [Query-Operatoren](#query-operatoren) diff --git a/docs/references/core-concepts.es.md b/docs/references/core-concepts.es.md index 7cdc3fc..6bc3bdd 100644 --- a/docs/references/core-concepts.es.md +++ b/docs/references/core-concepts.es.md @@ -5,9 +5,9 @@ Esta guía explica los conceptos fundamentales del ORM Dynamite y cómo trabajan ## Tabla de Contenidos 1. [Clase Table](#clase-table) -2. [Descripción General de Decoradores](#descripción-general-de-decoradores) +2. [Descripcion General de Decoradores](#descripcion-general-de-decoradores) 3. [Claves Primarias](#claves-primarias) -4. [Índices](#índices) +4. [Indices](#indices) 5. [Constructor de Consultas](#constructor-de-consultas) 6. [Operadores de Consulta](#operadores-de-consulta) 7. [Sistema de Tipos](#sistema-de-tipos) diff --git a/docs/references/decorators.de.md b/docs/references/decorators.de.md index 9d667e3..4acc1cf 100644 --- a/docs/references/decorators.de.md +++ b/docs/references/decorators.de.md @@ -4,19 +4,15 @@ Dieser Leitfaden bietet umfassende Dokumentation zu allen in Dynamite ORM verfü ## Inhaltsverzeichnis -1. [Einführung in Decorators](#einführung-in-decorators) -2. [@PrimaryKey - Primärschlüssel](#primarykey---primärschlüssel) -3. [@Index - GSI-Konfiguration](#index---gsi-konfiguration) -4. [@IndexSort - LSI-Konfiguration](#indexsort---lsi-konfiguration) -5. [@Default - Standardwerte](#default---standardwerte) -6. [@Validate - Validierungsfunktionen](#validate---validierungsfunktionen) -7. [@Mutate - Datentransformation](#mutate---datentransformation) -8. [@NotNull - Erforderliche Felder](#notnull---erforderliche-felder) -9. [@CreatedAt - Erstellungs-Zeitstempel](#createdat---erstellungs-zeitstempel) -10. [@UpdatedAt - Aktualisierungs-Zeitstempel](#updatedat---aktualisierungs-zeitstempel) -11. [@Name - Benutzerdefinierte Namen](#name---benutzerdefinierte-namen) -12. [@HasMany - Eins-zu-Viele-Beziehungen](#hasmany---eins-zu-viele-beziehungen) -13. [@BelongsTo - Viele-zu-Eins-Beziehungen](#belongsto---viele-zu-eins-beziehungen) +1. [Einfuhrung in Decorators](#einfuhrung-in-decorators) +2. [@PrimaryKey - Primarschlussel](#primarykey-primarschlussel) +3. [@Default - Standardwerte](#default-standardwerte) +4. [@Validate - Validierungsfunktionen](#validate-validierungsfunktionen) +5. [@Mutate - Datentransformation](#mutate-datentransformation) +6. [@NotNull - Erforderliche Felder](#notnull-erforderliche-felder) +7. [@CreatedAt - Erstellungs-Zeitstempel](#createdat-erstellungs-zeitstempel) +8. [@UpdatedAt - Aktualisierungs-Zeitstempel](#updatedat-aktualisierungs-zeitstempel) +9. [Best Practices](#best-practices) --- diff --git a/docs/references/decorators.es.md b/docs/references/decorators.es.md index a907eb9..7526e8c 100644 --- a/docs/references/decorators.es.md +++ b/docs/references/decorators.es.md @@ -4,24 +4,24 @@ Esta guía proporciona documentación exhaustiva sobre todos los decoradores dis ## Tabla de Contenidos -1. [Introducción a los Decoradores](#introducción-a-los-decoradores) -2. [@PrimaryKey - Claves Primarias](#primarykey---claves-primarias) -3. [@Index - Configuración de GSI](#index---configuración-de-gsi) -4. [@IndexSort - Configuración de LSI](#indexsort---configuración-de-lsi) -5. [@Default - Valores por Defecto](#default---valores-por-defecto) -6. [@Validate - Funciones de Validación](#validate---funciones-de-validación) -7. [@Mutate - Transformación de Datos](#mutate---transformación-de-datos) -8. [@Serialize - Transformación Bidireccional](#serialize---transformación-bidireccional) -9. [@NotNull - Campos Requeridos](#notnull---campos-requeridos) -10. [@CreatedAt - Timestamp de Creación](#createdat---timestamp-de-creación) -11. [@UpdatedAt - Timestamp de Actualización](#updatedat---timestamp-de-actualización) -12. [@DeleteAt - Soft Delete](#deleteat---soft-delete) -13. [@Name - Nombres Personalizados](#name---nombres-personalizados) -14. [@HasMany - Relaciones Uno a Muchos](#hasmany---relaciones-uno-a-muchos) -15. [@BelongsTo - Relaciones Muchos a Uno](#belongsto---relaciones-muchos-a-uno) -16. [Combinando Múltiples Decoradores](#combinando-múltiples-decoradores) +1. [Introduccion a los Decoradores](#introduccion-a-los-decoradores) +2. [@PrimaryKey - Claves Primarias](#primarykey-claves-primarias) +3. [@Index - Configuracion de GSI](#index-configuracion-de-gsi) +4. [@IndexSort - Configuracion de LSI](#indexsort-configuracion-de-lsi) +5. [@Default - Valores por Defecto](#default-valores-por-defecto) +6. [@Validate - Funciones de Validacion](#validate-funciones-de-validacion) +7. [@Mutate - Transformacion de Datos](#mutate-transformacion-de-datos) +8. [@Serialize - Transformacion Bidireccional](#serialize-transformacion-bidireccional) +9. [@NotNull - Campos Requeridos](#notnull-campos-requeridos) +10. [@CreatedAt - Timestamp de Creacion](#createdat-timestamp-de-creacion) +11. [@UpdatedAt - Timestamp de Actualizacion](#updatedat-timestamp-de-actualizacion) +12. [@DeleteAt - Soft Delete](#deleteat-soft-delete) +13. [@Name - Nombres Personalizados](#name-nombres-personalizados) +14. [@HasMany - Relaciones Uno a Muchos](#hasmany-relaciones-uno-a-muchos) +15. [@BelongsTo - Relaciones Muchos a Uno](#belongsto-relaciones-muchos-a-uno) +16. [Combinando Multiples Decoradores](#combinando-multiples-decoradores) 17. [Patrones de Decoradores Personalizados](#patrones-de-decoradores-personalizados) -18. [Mejores Prácticas](#mejores-prácticas) +18. [Mejores Practicas](#mejores-practicas) --- diff --git a/docs/references/decorators.md b/docs/references/decorators.md index a907eb9..7526e8c 100644 --- a/docs/references/decorators.md +++ b/docs/references/decorators.md @@ -4,24 +4,24 @@ Esta guía proporciona documentación exhaustiva sobre todos los decoradores dis ## Tabla de Contenidos -1. [Introducción a los Decoradores](#introducción-a-los-decoradores) -2. [@PrimaryKey - Claves Primarias](#primarykey---claves-primarias) -3. [@Index - Configuración de GSI](#index---configuración-de-gsi) -4. [@IndexSort - Configuración de LSI](#indexsort---configuración-de-lsi) -5. [@Default - Valores por Defecto](#default---valores-por-defecto) -6. [@Validate - Funciones de Validación](#validate---funciones-de-validación) -7. [@Mutate - Transformación de Datos](#mutate---transformación-de-datos) -8. [@Serialize - Transformación Bidireccional](#serialize---transformación-bidireccional) -9. [@NotNull - Campos Requeridos](#notnull---campos-requeridos) -10. [@CreatedAt - Timestamp de Creación](#createdat---timestamp-de-creación) -11. [@UpdatedAt - Timestamp de Actualización](#updatedat---timestamp-de-actualización) -12. [@DeleteAt - Soft Delete](#deleteat---soft-delete) -13. [@Name - Nombres Personalizados](#name---nombres-personalizados) -14. [@HasMany - Relaciones Uno a Muchos](#hasmany---relaciones-uno-a-muchos) -15. [@BelongsTo - Relaciones Muchos a Uno](#belongsto---relaciones-muchos-a-uno) -16. [Combinando Múltiples Decoradores](#combinando-múltiples-decoradores) +1. [Introduccion a los Decoradores](#introduccion-a-los-decoradores) +2. [@PrimaryKey - Claves Primarias](#primarykey-claves-primarias) +3. [@Index - Configuracion de GSI](#index-configuracion-de-gsi) +4. [@IndexSort - Configuracion de LSI](#indexsort-configuracion-de-lsi) +5. [@Default - Valores por Defecto](#default-valores-por-defecto) +6. [@Validate - Funciones de Validacion](#validate-funciones-de-validacion) +7. [@Mutate - Transformacion de Datos](#mutate-transformacion-de-datos) +8. [@Serialize - Transformacion Bidireccional](#serialize-transformacion-bidireccional) +9. [@NotNull - Campos Requeridos](#notnull-campos-requeridos) +10. [@CreatedAt - Timestamp de Creacion](#createdat-timestamp-de-creacion) +11. [@UpdatedAt - Timestamp de Actualizacion](#updatedat-timestamp-de-actualizacion) +12. [@DeleteAt - Soft Delete](#deleteat-soft-delete) +13. [@Name - Nombres Personalizados](#name-nombres-personalizados) +14. [@HasMany - Relaciones Uno a Muchos](#hasmany-relaciones-uno-a-muchos) +15. [@BelongsTo - Relaciones Muchos a Uno](#belongsto-relaciones-muchos-a-uno) +16. [Combinando Multiples Decoradores](#combinando-multiples-decoradores) 17. [Patrones de Decoradores Personalizados](#patrones-de-decoradores-personalizados) -18. [Mejores Prácticas](#mejores-prácticas) +18. [Mejores Practicas](#mejores-practicas) --- diff --git a/docs/references/migration.es.md b/docs/references/migration.es.md index 90b8048..5f322d7 100644 --- a/docs/references/migration.es.md +++ b/docs/references/migration.es.md @@ -5,11 +5,11 @@ Esta guía te ayuda a migrar a Dynamite desde otros ORMs o actualizar entre vers ## Tabla de Contenidos - [Migrar desde Otros ORMs](#migrar-desde-otros-orms) -- [Guía de Actualización de Versión](#guía-de-actualización-de-versión) -- [Migración de Esquema](#migración-de-esquema) -- [Migración de Datos](#migración-de-datos) +- [Guia de Actualizacion de Version](#guia-de-actualizacion-de-version) +- [Migracion de Esquema](#migracion-de-esquema) +- [Migracion de Datos](#migracion-de-datos) - [Pruebas de Migraciones](#pruebas-de-migraciones) -- [Despliegue en Producción](#despliegue-en-producción) +- [Despliegue en Produccion](#despliegue-en-produccion) ## Migrar desde Otros ORMs diff --git a/mkdocs.yml b/mkdocs.yml index 299a5ce..28ba941 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,27 +68,21 @@ nav: - Home: - Welcome: index.md - Installation: installation.md - - Changelog: CHANGELOG.md + - Getting Started: getting-started.md + - Changelog: changelog.md - - Guides: - - Getting Started: guides/getting-started.md - - Core Concepts: guides/core-concepts.md - - Decorators: guides/decorators.md - - Relationships: guides/relationships.md - - - API Reference: - - Table: api/table.md - - Client: api/client.md - - Types: api/types.md + - References: + - Core Concepts: references/core-concepts.md + - Decorators: references/decorators.md + - Table: references/table.md + - Client: references/client.md + - Types: references/types.md + - Migration Guide: references/migration.md - Examples: - - Basic Model: examples/basic-model.md - - Validation: examples/validation.md - - Relationships: examples/relationships.md - - Advanced Queries: examples/advanced-queries.md - - - Advanced: - - Migration Guide: advanced/migration.md + - Basic Model: examples/basic.md + - Relationships: examples/relations.md + - Advanced Queries: examples/advanced.md markdown_extensions: # Python Markdown @@ -158,22 +152,19 @@ plugins: Home: Inicio Welcome: Bienvenida Installation: Instalación - Changelog: Registro de Cambios - Guides: Guías Getting Started: Comenzando + Changelog: Registro de Cambios + References: Referencias Core Concepts: Conceptos Básicos Decorators: Decoradores - Relationships: Relaciones - API Reference: Referencia API Table: Tabla Client: Cliente Types: Tipos + Migration Guide: Guía de Migración Examples: Ejemplos Basic Model: Modelo Básico - Validation: Validación + Relationships: Relaciones Advanced Queries: Consultas Avanzadas - Advanced: Avanzado - Migration Guide: Guía de Migración - locale: de name: Deutsch build: true @@ -181,22 +172,19 @@ plugins: Home: Startseite Welcome: Willkommen Installation: Installation - Changelog: Änderungsprotokoll - Guides: Anleitungen Getting Started: Erste Schritte + Changelog: Änderungsprotokoll + References: Referenzen Core Concepts: Kernkonzepte Decorators: Dekoratoren - Relationships: Beziehungen - API Reference: API-Referenz Table: Tabelle Client: Client Types: Typen + Migration Guide: Migrationsanleitung Examples: Beispiele Basic Model: Grundlegendes Modell - Validation: Validierung + Relationships: Beziehungen Advanced Queries: Erweiterte Abfragen - Advanced: Erweitert - Migration Guide: Migrationsanleitung - minify: minify_html: true minify_js: true