From 92956daa2ac88c3751d19dd4a6e6534c15e06fd4 Mon Sep 17 00:00:00 2001 From: Fernando Date: Mon, 13 Jul 2026 12:59:40 +0200 Subject: [PATCH] docs: update README, AGENTS.md, CLAUDE.md with project info and codegraph - README: full project description, structure, commands, pages - AGENTS.md/CLAUDE.md: project overview, codegraph instructions, design tokens, page map --- AGENTS.md | 43 ++++++++++++++++-------- CLAUDE.md | 43 ++++++++++++++++-------- README.md | 99 +++++++++++++++++++++++++++++++++++-------------------- 3 files changed, 122 insertions(+), 63 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index c5ff429..0b1ffab 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,22 +1,37 @@ -## Development +## Proyecto -When starting the dev server, use background mode: +Ornitonautas — Portal de FP informática en España. +Stack: Astro + Tailwind CSS v4 + TypeScript. I18n: es/en. -``` -astro dev --background +## CodeGraph + +Indexar el proyecto con `codegraph index` para mantener el grafo de dependencias actualizado. + +## Desarrollo + +```sh +pnpm dev # Servidor en localhost:4321 +pnpm build # Build estático → dist/ ``` -Manage the background server with `astro dev stop`, `astro dev status`, and `astro dev logs`. +## Estructura clave -## Documentation +- `src/pages/` — Rutas (index.astro = home es, en/index.astro = home en) +- `src/components/` — Header.astro, Footer.astro +- `src/layouts/BaseLayout.astro` — Layout base con SEO + JSON-LD +- `src/styles/global.css` — Tokens de diseño (Tailwind @theme) +- `src/i18n/` — Diccionarios es/en +- `src/content.config.ts` — Schemas de colecciones +- `agents/` — Agentes CodeGraph +- `DESIGN.md` — Sistema visual (opción 1a) +- `docs/` — Ontología FP, estrategia SEO/GEO -Full documentation: https://docs.astro.build +## Diseño -Consult these guides before working on related tasks: +Seguir DESIGN.md (opción 1a: "Luminoso y limpio"). +Colores: navy #13294b, naranja #f47a20. Fuentes: Space Grotesk + Manrope. +Un CTA por bloque. Mucho espacio en blanco. -- [Adding pages, dynamic routes, or middleware](https://docs.astro.build/en/guides/routing/) -- [Working with Astro components](https://docs.astro.build/en/basics/astro-components/) -- [Using React, Vue, Svelte, or other framework components](https://docs.astro.build/en/guides/framework-components/) -- [Adding or managing content](https://docs.astro.build/en/guides/content-collections/) -- [Adding styles or using Tailwind](https://docs.astro.build/en/guides/styling/) -- [Supporting multiple languages](https://docs.astro.build/en/guides/internationalization/) +## Páginas + +Home → Campus (DAW/ASIR/DAM) → Formación → Rutas profesionales → Recursos → Comunidad → Sobre nosotros → Contacto diff --git a/CLAUDE.md b/CLAUDE.md index c5ff429..0b1ffab 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,22 +1,37 @@ -## Development +## Proyecto -When starting the dev server, use background mode: +Ornitonautas — Portal de FP informática en España. +Stack: Astro + Tailwind CSS v4 + TypeScript. I18n: es/en. -``` -astro dev --background +## CodeGraph + +Indexar el proyecto con `codegraph index` para mantener el grafo de dependencias actualizado. + +## Desarrollo + +```sh +pnpm dev # Servidor en localhost:4321 +pnpm build # Build estático → dist/ ``` -Manage the background server with `astro dev stop`, `astro dev status`, and `astro dev logs`. +## Estructura clave -## Documentation +- `src/pages/` — Rutas (index.astro = home es, en/index.astro = home en) +- `src/components/` — Header.astro, Footer.astro +- `src/layouts/BaseLayout.astro` — Layout base con SEO + JSON-LD +- `src/styles/global.css` — Tokens de diseño (Tailwind @theme) +- `src/i18n/` — Diccionarios es/en +- `src/content.config.ts` — Schemas de colecciones +- `agents/` — Agentes CodeGraph +- `DESIGN.md` — Sistema visual (opción 1a) +- `docs/` — Ontología FP, estrategia SEO/GEO -Full documentation: https://docs.astro.build +## Diseño -Consult these guides before working on related tasks: +Seguir DESIGN.md (opción 1a: "Luminoso y limpio"). +Colores: navy #13294b, naranja #f47a20. Fuentes: Space Grotesk + Manrope. +Un CTA por bloque. Mucho espacio en blanco. -- [Adding pages, dynamic routes, or middleware](https://docs.astro.build/en/guides/routing/) -- [Working with Astro components](https://docs.astro.build/en/basics/astro-components/) -- [Using React, Vue, Svelte, or other framework components](https://docs.astro.build/en/guides/framework-components/) -- [Adding or managing content](https://docs.astro.build/en/guides/content-collections/) -- [Adding styles or using Tailwind](https://docs.astro.build/en/guides/styling/) -- [Supporting multiple languages](https://docs.astro.build/en/guides/internationalization/) +## Páginas + +Home → Campus (DAW/ASIR/DAM) → Formación → Rutas profesionales → Recursos → Comunidad → Sobre nosotros → Contacto diff --git a/README.md b/README.md index 414a13a..94e497f 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,75 @@ -# Astro Starter Kit: Basics +# Ornitonautas + +Portal de aprendizaje de informática. Formación de FP oficial en España + preparación para el mercado laboral tech. + +## Stack + +- **Framework:** [Astro](https://astro.build) (SSG) +- **Estilos:** [Tailwind CSS](https://tailwindcss.com) v4 +- **Lenguajes:** TypeScript, Astro components +- **I18n:** es (default) / en + +## Estructura -```sh -npm create astro@latest -- --template basics ``` - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! - -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text / -├── public/ -│ └── favicon.svg -├── src -│   ├── assets -│   │   └── astro.svg -│   ├── components -│   │   └── Welcome.astro -│   ├── layouts -│   │   └── Layout.astro -│   └── pages -│   └── index.astro +├── agents/ # Agentes de código (codegraph) +├── docs/ # Documentación del proyecto +├── img/ # Imágenes fuente +├── public/ # Assets estáticos (favicon, logos) +├── src/ +│ ├── components/ # Componentes Astro (Header, Footer) +│ ├── content/ # Colecciones de contenido (MDX) +│ ├── i18n/ # Diccionarios de traducción +│ ├── layouts/ # Layouts (BaseLayout) +│ ├── pages/ # Rutas (es/, en/, campus/, etc.) +│ └── styles/ # Estilos globales (Tailwind) +├── AGENTS.md # Instrucciones para agentes +├── CLAUDE.md # Instrucciones para Claude +├── DESIGN.md # Sistema visual y tokens └── package.json ``` -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). +## Comandos -## 🧞 Commands +```sh +pnpm install # Instalar dependencias +pnpm dev # Servidor de desarrollo (localhost:4321) +pnpm build # Build de producción → dist/ +pnpm preview # Preview del build +``` -All commands are run from the root of the project, from a terminal: +## Desarrollo -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +El servidor de desarrollo se ejecuta con `pnpm dev` en el directorio raíz. +Escucha en `http://localhost:4321/`. -## 👀 Want to learn more? +### Páginas -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +| Ruta | Descripción | +|---|---| +| `/` | Home (es) | +| `/en/` | Home (en) | +| `/campus/` | Ciclos formativos | +| `/formacion/` | Formación | +| `/aprendizaje/` | Rutas de aprendizaje | +| `/recursos/` | Recursos | +| `/comunidad/` | Comunidad | +| `/sobre-nosotros/` | Sobre nosotros | +| `/contacto/` | Contacto | + +## CodeGraph + +Este proyecto usa [CodeGraph](https://codegraph.dev) para mantener indexado el código fuente. + +- La base de datos está en `.codegraph/codegraph.db` (ignorada por git) +- Los agentes están en `agents/` y definen cómo interactúa cada agente con el proyecto +- Ejecutar `codegraph index` para re-indexar después de cambios significativos + +## Despliegue + +Pendiente de configurar. Planeado: Podman + Traefork en VPS Fedora/CentOS. + +## Licencia + +Propietario — Ornitonautas