From 6c2ff4793e64c9bbbe1ce7973dd8b2fa8ea803ef Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Fri, 6 Dec 2024 14:07:10 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Completa=20la=20documentaci?= =?UTF-8?q?=C3=B3n=20para=20el=20"workspace"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 44 ++++++++++++++++++++++---------- helpers/pagetop-build/README.md | 2 +- helpers/pagetop-build/src/lib.rs | 2 +- 3 files changed, 33 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7e0a72cc..c4ce5922 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,14 @@ -**PageTop** reúne algunos de los *crates* más estables y populares del ecosistema Rust para -proporcionar un conjunto completo de funcionalidades que pueden extenderse y adaptarse a las -necesidades específicas de cada aplicación web. - -PageTop reivindica la sencillez de la web clásica aplicando *renderizado en el servidor* (SSR), -HTML, CSS y JS, mediante acciones, componentes, diseños y paquetes: +**PageTop** reivindica la sencillez de la web clásica utilizando SSR (*renderizado en el servidor*), +HTML, CSS y JavaScript. Proporciona un conjunto completo de funcionalidades que pueden extenderse y +adaptarse a las necesidades de cada solución web implementando: * **Acciones** (*actions*). Las funcionalidades que incorporen acciones en su lógica de programa estarán proporcionando a los desarrolladores herramientas para alterar su comportamiento interno interceptando su flujo de ejecución. - * **Componentes** (*components*). Encapsulan HTML, CSS y JavaScript en unidades funcionales, + * **Componentes** (*components*). Para encapsular HTML, CSS y JavaScript en unidades funcionales, configurables y bien definidas. * **Diseños** (*layouts*). Permiten a los desarrolladores modificar la apariencia de páginas y componentes sin afectar a su funcionalidad. @@ -74,14 +71,35 @@ Este programa prepara un paquete personalizado llamado `HelloWorld` que sirve un ruta raíz (`/`) mostrando el mensaje "Hello world!" en un elemento HTML `

`. -# 📂 Crates de ayuda +# 📂 Estructura del código - * [pagetop-macros](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-macros): - Proporciona una colección de macros que mejoran la experiencia de desarrollo con PageTop. +El repositorio se organiza en un *workspace* con los siguientes subproyectos: - * [pagetop-build](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-build): - Permite incluir fácilmente archivos estáticos o archivos SCSS compilados, directamente en el - binario de las aplicaciones PageTop. + * **[pagetop](https://github.com/manuelcillero/pagetop/tree/latest/pagetop)**, es la librería + principal. Reúne algunos de los *crates* más estables y populares del ecosistema Rust para + proporcionar APIs, patrones de desarrollo y buenas prácticas para la creación avanzada de + soluciones web SSR (*Server-Side Rendering*). + +## Auxiliares + + * **[pagetop-build](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-build)**, + permite incluir fácilmente archivos estáticos o archivos SCSS compilados directamente en el + binario de las aplicaciones **PageTop**. + + * **[pagetop-macros](https://github.com/manuelcillero/pagetop/tree/latest/helpers/pagetop-macros)**, + proporciona una colección de macros que mejoran la experiencia de desarrollo con **PageTop**. + +## Paquetes + + * **[pagetop-seaorm](https://github.com/manuelcillero/pagetop/tree/latest/packages/pagetop-seaorm)**, + integra [SeaORM](https://www.sea-ql.org/SeaORM) para trabajar con bases de datos en aplicaciones + **PageTop**. + +## Aplicación + + * **[drust](https://github.com/manuelcillero/pagetop/tree/latest/drust)**, es una aplicación que + utiliza **PageTop** para crear un Sistema de Gestión de Contenidos (CMS) que permita construir + sitios web dinámicos, administrados y configurables. # 🚧 Advertencia diff --git a/helpers/pagetop-build/README.md b/helpers/pagetop-build/README.md index 13356e16..abb9fa98 100644 --- a/helpers/pagetop-build/README.md +++ b/helpers/pagetop-build/README.md @@ -2,7 +2,7 @@

PageTop Build

-

Incluye fácilmente archivos estáticos o archivos SCSS compilados, directamente en el binario de tus aplicaciones PageTop.

+

Incluye fácilmente archivos estáticos o archivos SCSS compilados directamente en el binario de tus aplicaciones PageTop.

[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](#-license) [![Doc API](https://img.shields.io/docsrs/pagetop-build?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-build) diff --git a/helpers/pagetop-build/src/lib.rs b/helpers/pagetop-build/src/lib.rs index 5f2aed5d..fa4a9249 100644 --- a/helpers/pagetop-build/src/lib.rs +++ b/helpers/pagetop-build/src/lib.rs @@ -1,4 +1,4 @@ -//! Incluye fácilmente archivos estáticos o archivos SCSS compilados, directamente en el binario de +//! Incluye fácilmente archivos estáticos o archivos SCSS compilados directamente en el binario de //! tus aplicaciones **PageTop**. //! //! # Añadir al proyecto