Skip to content

Commit 8e2821e

Browse files
committed
doc: add mention to the dedicated documentation page
1 parent 0dc2611 commit 8e2821e

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,17 @@
3939

4040
This repository contains the practical work for the Programming Paradigms course at the [National University of La Matanza (UNLaM)](https://www.unlam.edu.ar/). The practical work consists of doing a crafting system in Java and testing it with [JUnit 5](https://junit.org/junit5/).
4141

42+
> [!TIP]
43+
> If you want the read an extensive documentation of each process involved within the system, consult the [dedicated documentation page](https://deepwiki.com/hozlucas28/Java-Practical-Work-2025).
44+
4245
## Features
4346

4447
- Architecture planning
4548
- Code conventions and standards
4649
- Code documentation using [JavaDoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html) syntax
4750
- Collections
4851
- Commits following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
52+
- Dedicated documentation page
4953
- Deployment of releases
5054
- E2E testing with [JUnit 5](https://junit.org/junit5/)
5155
- File reading and interpretation

docs/translations/es/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939

4040
Este repositorio contiene el trabajo práctico para el curso de Paradigmas de Programación en la [Universidad Nacional de La Matanza (UNLaM)](https://www.unlam.edu.ar/). El trabajo práctico consiste en realizar un sistema de crafteo en Java y probarlo con [JUnit 5](https://junit.org/junit5/).
4141

42+
> [!TIP]
43+
> Si desea leer una documentación extensa de cada proceso involucrado dentro del sistema, consulte la [página con la documentación dedicada](https://deepwiki.com/hozlucas28/Java-Practical-Work-2025).
44+
4245
## Características
4346

4447
- Almacenamiento local de registros
@@ -49,6 +52,7 @@ Este repositorio contiene el trabajo práctico para el curso de Paradigmas de Pr
4952
- Despliegue de versiones
5053
- Documentación del código usando la sintaxis de [JavaDoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)
5154
- Lectura e interpretación de archivos
55+
- Página de documentación dedicada
5256
- Planificación de arquitectura
5357
- Planificación del flujo de trabajo en equipo (ramas, etiquetas y versiones)
5458
- Pruebas E2E con [JUnit 5](https://junit.org/junit5/)

0 commit comments

Comments
 (0)