docs: 📚 Scribe - Clarify docs symlink in README#551
Conversation
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>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Deploying cvix with
|
| Latest commit: |
2a5a070
|
| Status: | 🚫 Build failed. |
github-actions
bot
added
the
area:docs
📝 WalkthroughSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings. WalkthroughDocumentation update clarifying that the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 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.
| > **Note:** The `docs/` directory is a symlink to `client/apps/docs/src/content/docs/`. | ||
| > It is automatically created by running `make prepare-env`. | ||
|
|
There was a problem hiding this comment.
🧹 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.
Qodana for JVM105 new problems were found
☁️ View the detailed Qodana report Contact Qodana teamContact us at qodana-support@jetbrains.com
|
1 participant
This change fixes the broken
docs@symlink and updates the mainREADME.mdto clarify the documentation structure and setup process. This addresses an issue where the symlink was not correctly created in a fresh clone, and the documentation did not explain how to fix it.PR created automatically by Jules for task 10262607841924130248 started by @yacosta738