-
Notifications
You must be signed in to change notification settings - Fork 6
docs: align Development Guide with current repo structure #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: align Development Guide with current repo structure #56
Conversation
Co-authored-by: mahid797 <31464238+mahid797@users.noreply.github.com>
LangRoute repository.
**Absolute scope:** Update a single file on the **dev branch only**: `docs/development-g...|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughRestructures docs/development-guide.md: replaces intro with a “Development Guide” title, reorganizes sections, updates guidance, examples, paths, and internal links, adds meta-guidance on routing and architecture placement, replaces historical references, and updates the “Last updated” timestamp to 2025-09-25. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested labels
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refreshes the Development Guide to accurately reflect the current dev branch structure and conventions, replacing outdated path references and wiki links with verified information.
- Consolidates content from 464 to 154 lines while preserving all essential technical guidance
- Updates all directory paths to match the actual codebase structure with proper import aliases
- Adds critical shadcn/ui modification warning and replaces broken wiki references with internal docs
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
.coderabbit.yamlis excluded by none and included by none
📒 Files selected for processing (1)
docs/development-guide.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
⚙️ CodeRabbit configuration file
docs/**: Keep Development Guide aligned with current directory structure and conventions. Update docs when APIs/routes/schemas change.
Files:
docs/development-guide.md
🪛 markdownlint-cli2 (0.18.1)
docs/development-guide.md
9-9: Blank line inside blockquote
(MD028, no-blanks-blockquote)
148-148: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
156-156: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
156-156: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
156-156: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
This PR refreshes the Development Guide to accurately reflect the current
devbranch structure and conventions. The previous guide contained outdated path references and wiki links that no longer matched the actual codebase organization.Key Changes
Updated directory structure to match reality:
src/app/(server)/api/**/route.ts(confirmed no_apiprefix or versioning)src/app/(server)/services/**(verified actual location)src/lib/validation/**(confirmed with existing schemas)src/app/(client)/components/**(matches current structure)src/lib/utils/**withcn()inclassnames.tsReplaced outdated references:
architecture.mdandgetting-started.mdtsconfig.json(@services,@lib, etc.)Added required shadcn rule:
src/shadcn-ui/**filessrc/app/(client)/components/**insteadStreamlined content:
Summary by CodeRabbit