Skip to content
This repository was archived by the owner on Feb 18, 2026. It is now read-only.

docs: 📚 Scribe - Clarify docs symlink in README #551

Open
yacosta738 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: 📚 Scribe - Clarify docs symlink in README #551

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Comment on lines +92 to +94
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial

Clear and helpful documentation.

The note effectively explains the symlink structure and provides the setup command. New developers will immediately understand why docs/ might be missing or broken in a fresh clone and how to fix it.

💡 Optional enhancement: Mention file modification behavior

Consider briefly noting that modifications should be made through the symlink (or conversely, that changes propagate to the actual location). This could prevent confusion about where edits should be made:

 > **Note:** The `docs/` directory is a symlink to `client/apps/docs/src/content/docs/`.
-> It is automatically created by running `make prepare-env`.
+> It is automatically created by running `make prepare-env`. Changes made through
+> either path will affect the same files.

This is entirely optional and may be considered obvious to most developers.

🤖 Prompt for AI Agents 
In `@README.md` around lines 92 - 94, Update the README note about the docs
symlink to also state where edits should be made and how changes propagate:
amend the existing paragraph that mentions "The `docs/` directory is a symlink
to `client/apps/docs/src/content/docs/`" to add a brief sentence like "Edit
files via the `docs/` symlink (changes will apply to
`client/apps/docs/src/content/docs/`) or, if you prefer, edit the target
directly" and keep the existing instruction to run `make prepare-env`; ensure
the clarification is concise and placed immediately after the existing symlink
explanation.

---

## 🧰 Tech Stack
Expand Down
Loading