From 2a5a0704a31d19c7dc1e8cb601f05b51231cc656 Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
 <161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Thu, 29 Jan 2026 11:15:43 +0000
Subject: [PATCH] docs: Clarify docs symlink and setup in README

The root `docs/` directory is a symlink to the actual documentation content located at `client/apps/docs/src/content/docs/`. This was not clearly explained, and the symlink could be broken in a fresh clone.

This commit updates the "Project Structure" section of the main `README.md` to clarify that `docs/` is a symlink and instructs users to run `make prepare-env` to ensure it is set up correctly. This improves the developer onboarding experience.

Co-authored-by: yacosta738 <33158051+yacosta738@users.noreply.github.com>
---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 489ae2866..367110de2 100644
--- a/README.md
+++ b/README.md
@@ -85,10 +85,13 @@ ProFileTailors is a **production-grade platform** for creating, customizing, and
 ├── server/   # Backend: Spring Boot, Kotlin, PostgreSQL
 ├── shared/   # Kotlin shared libs
 ├── infra/    # Infra as code: Docker Compose, secrets, monitoring
-├── docs/     # Astro-powered docs site
+├── docs/     # Astro-powered docs site (symlink)
 ├── .agents/  # AI agent configs, skills & workflow guides
 ```
 
+> **Note:** The `docs/` directory is a symlink to `client/apps/docs/src/content/docs/`.
+> It is automatically created by running `make prepare-env`.
+
 ---
 
 ## 🧰 Tech Stack