docs: align docs paths and onboarding prerequisites#111
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughUpdates documentation build targets to use pnpm in the web monorepo and revises site content to reflect a restructured clients/web layout (apps/docs, apps/dashboard, apps/marketing), plus expanded prerequisites and path adjustments in English and Spanish guides. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Contributor
✅ Contributor ReportUser: @yacosta738
Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-28 to 2026-02-28 |
Deploying corvus with
|
| Latest commit: |
24d4ba8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://faa29d8d.corvus-42x.pages.dev |
| Branch Preview URL: | https://docstemp.corvus-42x.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
clients/web/apps/docs/src/content/docs/en/guides/architecture.md (1)
127-154:⚠️ Potential issue | 🟡 MinorDuplicate sections detected—remove redundant content.
Lines 127-154 ("Build Logic" and "Dependency Management") are exact duplicates of lines 60-89. This appears to be a copy-paste error.
🔧 Proposed fix: Remove duplicate sections
See [Architecture Index](./architecture/index.md) for more details on how to visualize them. - -## Build Logic (Convention Plugins) - -Instead of repeating build logic in every `build.gradle.kts`, we use **Convention Plugins** located -in `gradle/build-logic`. - -### Plugin Categories - -1. **Base Plugins**: Fundamental configuration like identity, lifecycle, and JVM conflict - resolution. -2. **Module Plugins**: Language-specific configurations (`kotlin`, `java`, `spring-boot`). -3. **Feature Plugins**: Opt-in features like `publish-library`, `shadow`, `test-fixtures`, and - `git-hook`. -4. **Check Plugins**: Code quality and formatting tools (`spotless`, `detekt`, `spotbugs`). -5. **Report Plugins**: Aggregated reports for testing, coverage, and SBOM. - -## Dependency Management - -We use **Gradle Version Catalogs** (`libs.versions.toml`) to define all dependencies and versions in -a single location. This ensures consistency across all modules. - -### Example usage: - -```kotlin -dependencies { - implementation(libs.kotlin.stdlib) - testImplementation(libs.junit.jupiter) -} -```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@clients/web/apps/docs/src/content/docs/en/guides/architecture.md` around lines 127 - 154, Remove the duplicated "Build Logic (Convention Plugins)" and "Dependency Management" sections (including the example dependencies code block) that repeat content already present earlier; keep a single copy of those sections and delete the redundant copy starting at the second occurrence so headings "Build Logic (Convention Plugins)", "Dependency Management" and the code example using implementation(libs.kotlin.stdlib) / testImplementation(libs.junit.jupiter) only appear once.
🧹 Nitpick comments (1)
Makefile (1)
35-35: Remove the unusedDOCS_MODULEvariable or refactordocs-web-*targets to use it.The variable defined on line 35 is not referenced anywhere in the Makefile. All
docs-web-*targets hardcode the pathclients/web/apps/docsinstead of using this variable. Either remove the unused variable or refactor the targets to reference it (e.g.,@cd clients/$(DOCS_MODULE)/apps/docs && pnpm run build) for consistency.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@Makefile` at line 35, The Makefile defines DOCS_MODULE but never uses it; update the docs-web-* targets to reference $(DOCS_MODULE) instead of hardcoding clients/web/apps/docs (or remove DOCS_MODULE if you prefer deletion). Locate the docs-web-* targets and replace occurrences of clients/web/apps/docs with clients/$(DOCS_MODULE)/apps/docs (e.g., commands that cd to that path or run pnpm from there) so the variable is actually used and keeps paths consistent with DOCS_MODULE, or remove the DOCS_MODULE assignment if you choose to eliminate the unused variable.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@clients/web/apps/docs/src/content/docs/en/guides/architecture.md`:
- Around line 127-154: Remove the duplicated "Build Logic (Convention Plugins)"
and "Dependency Management" sections (including the example dependencies code
block) that repeat content already present earlier; keep a single copy of those
sections and delete the redundant copy starting at the second occurrence so
headings "Build Logic (Convention Plugins)", "Dependency Management" and the
code example using implementation(libs.kotlin.stdlib) /
testImplementation(libs.junit.jupiter) only appear once.
---
Nitpick comments:
In `@Makefile`:
- Line 35: The Makefile defines DOCS_MODULE but never uses it; update the
docs-web-* targets to reference $(DOCS_MODULE) instead of hardcoding
clients/web/apps/docs (or remove DOCS_MODULE if you prefer deletion). Locate the
docs-web-* targets and replace occurrences of clients/web/apps/docs with
clients/$(DOCS_MODULE)/apps/docs (e.g., commands that cd to that path or run
pnpm from there) so the variable is actually used and keeps paths consistent
with DOCS_MODULE, or remove the DOCS_MODULE assignment if you choose to
eliminate the unused variable.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (8)
MakefileREADME.mdclients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/en/guides/getting-started.mdclients/web/apps/docs/src/content/docs/en/guides/structure.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/getting-started.mdclients/web/apps/docs/src/content/docs/es/guides/structure.md
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
clients/web/apps/docs/src/content/docs/en/guides/architecture.md (1)
17-17: Consider clarifying the "monorepo" terminology.The term "Web monorepo" might be confusing since the entire project structure appears to be a monorepo. Consider using "Web workspace" or simply "Web apps (docs, dashboard, marketing)" for clarity.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@clients/web/apps/docs/src/content/docs/en/guides/architecture.md` at line 17, Replace the ambiguous comment on the directory line "└── web/ # Web monorepo (docs, dashboard, marketing)" with clearer wording—either "Web workspace (docs, dashboard, marketing)" or "Web apps (docs, dashboard, marketing)"—so readers don't assume the entire repo is a monorepo; update the comment text adjacent to the "└── web/" entry accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@clients/web/apps/docs/src/content/docs/en/guides/architecture.md`:
- Line 17: Replace the ambiguous comment on the directory line "└── web/
# Web monorepo (docs, dashboard, marketing)" with clearer wording—either "Web
workspace (docs, dashboard, marketing)" or "Web apps (docs, dashboard,
marketing)"—so readers don't assume the entire repo is a monorepo; update the
comment text adjacent to the "└── web/" entry accordingly.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
Makefileclients/web/apps/docs/src/content/docs/en/guides/architecture.md
🚧 Files skipped from review as they are similar to previous changes (1)
- Makefile
|
This was referenced Feb 28, 2026
This was referenced Mar 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request refactors documentation and build system references to clarify the project's structure and update tooling instructions. The main changes are the migration of documentation references from
docstoclients/web/apps/docs, updates to build commands to usepnpminstead of Gradle for documentation, and improvements to documentation in both English and Spanish to reflect the new organization and prerequisites.Project structure and documentation updates:
Updated all references to the documentation directory from
docstoclients/web/apps/docsacross the codebase, including the architecture and structure guides in both English and Spanish. This clarifies that documentation is now located in the web monorepo. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Improved documentation to describe the web monorepo structure, detailing sub-apps for docs, dashboard, and marketing, and specifying the agent runtime as a Rust project. [1] [2]
Build system and tooling changes:
Makefilefrom Gradle tasks to directpnpmcommands in the new documentation directory, reflecting the migration to a JavaScript-based documentation system. [1] [2]Prerequisites and contributing guide updates:
Updated prerequisites in the "Getting Started" guides (English and Spanish) to include Rust, Node.js, pnpm, and Docker, aligning with the new tech stack. [1] [2]
Improved links and instructions in the
README.mdfor accessing documentation and contributing, including a direct link to the contributing guide. [1] [2]Summary by CodeRabbit
Documentation
Chores