Merge pull request #5 from pascalgrimaud/improve-home-page

Improve home page

Author: pascalgrimaud

.github/workflows/deploy.yml

@@ -6,9 +6,9 @@ on:
       - main
 
 jobs:
-  deploy:
+  build:
+    name: build
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -18,16 +18,28 @@ jobs:
         with:
           node-version: 'lts/*'
 
-      - name: Install deps
+      - name: Install dependencies
         run: npm ci
 
       - name: Build VitePress site
         run: npx vitepress build
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v4
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: .vitepress/dist
-          publish_branch: gh-pages
-          cname: ''
+          path: .vitepress/dist
+
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.vitepress/config.mts

@@ -9,23 +9,28 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' },
+      { text: 'Guide', link: '/docs/guide/getting-started' },
+      { text: 'Use Cases', link: '/docs/use-cases' },
     ],
 
     sidebar: [
       {
-        text: 'Examples',
+        text: 'Introduction',
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' },
+          { text: 'Why Seed4J', link: '/docs/guide/why-seed4j' },
+          { text: 'Getting Started', link: '/docs/guide/getting-started' },
         ],
       },
+      {
+        text: 'Use cases',
+        items: [],
+      },
     ],
 
     socialLinks: [
       { icon: 'linkedin', link: 'https://www.linkedin.com/company/seed4j' },
       { icon: 'x', link: 'https://x.com/seed4j' },
-      { icon: 'github', link: 'https://github.com/seed4j/seed4j' }
+      { icon: 'github', link: 'https://github.com/seed4j/seed4j' },
     ],
   },
 });

README.md

@@ -16,14 +16,10 @@ You will only need to run this command when dependencies change in [package.json
 npm install
 ```
 
-## Local environment
-
-<!-- jhipster-needle-localEnvironment -->
-
 ## Start up
 
-<!-- jhipster-needle-startupCommand -->
-
-## Documentation
+Launch:
 
-<!-- jhipster-needle-documentation -->
+```
+npm run docs:dev
+```

docs/guide/getting-started.md

@@ -0,0 +1,75 @@
+---
+title: Getting Started | Guide
+---
+
+# Getting Started
+
+## Prerequisites
+
+### Java
+
+You need [Java 21](https://openjdk.java.net/projects/jdk/21/).
+
+### Node.js and npm
+
+[Node.js](https://nodejs.org/) is required to run the development web server and build the project.  
+Depending on your system, you can install Node.js from source or use a pre-built installer.
+
+### Verify your installation
+
+Open your terminal and run the following commands to verify that Java and Node.js are correctly installed:
+
+```bash
+java -version && javac -version
+```
+
+```bash
+node -v && npm -v
+```
+
+Example output:
+
+```
+➜ java -version && javac -version
+openjdk version "21.0.8" 2025-07-15
+OpenJDK Runtime Environment (build 21.0.8+9-Ubuntu-0ubuntu124.04.1)
+OpenJDK 64-Bit Server VM (build 21.0.8+9-Ubuntu-0ubuntu124.04.1, mixed mode, sharing)
+javac 21.0.8
+
+➜ node -v && npm -v
+v22.17.1
+11.5.1
+```
+
+## Quick Start
+
+Clone the project and navigate into the directory:
+
+```bash
+git clone https://github.com/seed4j/seed4j
+cd seed4j
+```
+
+Start the application:
+
+```bash
+./mvnw
+```
+
+On Windows
+
+```bash
+mvnw.cmd
+```
+
+You should see logs like:
+
+```
+----------------------------------------------------------
+  Application 'seed4j' is running!
+  Local: 	    http://localhost:7471/
+  External: 	http://127.0.1.1:7471/
+----------------------------------------------------------
+```
+
+Now open [http://localhost:7471](http://localhost:7471/) in your browser.

docs/guide/why-seed4j.md

@@ -0,0 +1,35 @@
+---
+title: Why Seed4J | Guide
+---
+
+# Why Seed4J?
+
+Seed4J is a modular code generator that helps developers bootstrap their applications with clarity, structure, and purpose. Whether you're building a proof of concept or a scalable application, Seed4J offers a clean and efficient foundation designed to grow with your project.
+
+## 🧩 Modular Code Generation
+
+Seed4J is built around the idea of generating only what you need, nothing more.
+
+Instead of overwhelming you with a full stack of technologies or bloated code you won't use, Seed4J guides you step-by-step through creating only the features and technical layers your project requires. This modular approach gives you full control over your architecture, helps you stay focused, and keeps your codebase lightweight and maintainable.
+
+As your application evolves, you can add new modules when you need them, not before. No unused code, no technical debt from the start.
+
+## 🛡️ Clean & Hexagonal Architecture
+
+Seed4J is not just about generating code, it’s about generating the right code, based on clean architecture principles.
+
+The entire platform is built on **hexagonal architecture**, encouraging a clear separation between domain logic and infrastructure. This makes your application easier to test, adapt, and evolve over time.
+
+By default, Seed4J promotes clean code practices, organizing your project into well-defined layers. Business logic is kept at the center, while technical concerns like persistence or web APIs are placed at the edges. This architecture is a solid foundation for long-term scalability and quality.
+
+## 🎯 Designed for Developer Experience
+
+From setup to daily development, Seed4J is designed with **developer experience** in mind.
+
+The project includes out-of-the-box tooling, fast startup time, and carefully crafted conventions to make development smoother. No more boilerplate or confusing configuration, you get a ready-to-run app in seconds.
+
+Beyond tooling, Seed4J promotes **craftsmanship**: it encourages writing readable, maintainable, and well-tested code. With features like 100% test coverage, zero duplication, and clean separation of concerns, it’s the kind of foundation developers are proud to build on.
+
+---
+
+Whether you're new to Java or a seasoned backend expert, Seed4J gives you a clean, focused, and professional starting point, ready to evolve with your needs.

docs/use-cases/index.md

@@ -0,0 +1,21 @@
+---
+title: Use Cases | Use Cases
+---
+
+# Use Cases
+
+Seed4J can be used in different contexts, from quick experiments to real-world applications. This page gives you an overview of the main use cases, with dedicated guides for each.
+
+- 🧪 [Minimal project scaffolding](./use-cases/minimal-project.md):  
+  Generate basic files like `.gitignore`, `README.md`, and license, ideal to start cleanly.
+
+- 🥋 [Java kata project](./use-cases/java-kata.md):  
+  Bootstrap a simple Java app with tests, perfect for TDD sessions or coding katas.
+
+- 🥋 [TypeScript kata project](./use-cases/ts-kata.md):  
+  Quickly set up a TypeScript-based kata environment with linting and tests.
+
+- 🚀 [Real Java backend project](./use-cases/java-backend.md):  
+  Start a fully structured backend with Spring Boot, hexagonal architecture, and Tomcat.
+
+Each guide provides specific steps tailored to that context, so you only generate what you really need.

index.md

@@ -1,24 +1,32 @@
 ---
-# https://vitepress.dev/reference/default-theme-home-page
 layout: home
 
 hero:
-  name: 'Seed4J 🌱'
+  name: 'Seed4J'
   text: 'Modular code generator with clean architecture'
-  tagline: Plant the right seed, build on strong roots.
+  tagline: Plant the right seed 🌱 build on strong roots.
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Get Started
+      link: /docs/guide/getting-started
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Why Seed4J ?
+      link: /docs/guide/why-seed4j
+    - theme: alt
+      text: Use cases
+      link: /docs/use-cases/
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/seed4j/seed4j
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - icon: 🧩
+    title: Modular Code Generation
+    details: Generate only what you need, when you need, nothing more.
+  - icon: 🛡️
+    title: Clean & Hexagonal Architecture
+    details: Based on clean code and hexagonal architecture from the ground up.
+  - icon: 🎯
+    title: Designed for Developer Experience
+    details: Fast setup and high-quality code for productive devs who care about craftsmanship.
 ---