fix(docs): correct guide links for architecture, release, and getting started#187
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughSummary by CodeRabbit
WalkthroughUpdated C4 diagram links in the English and Spanish architecture guides to use root‑relative paths under Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 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 ReportUser: @yacosta738
Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-03-10 to 2026-03-10 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@clients/web/apps/docs/src/content/docs/en/guides/architecture.md`:
- Around line 120-123: Update the three remaining rows so their diagram links
use the same ./architecture/diagrams/... base as C1: change the link targets for
"C2 - Containers" to ./architecture/diagrams/container/runtime-containers.mmd,
for "C3 - Components" to ./architecture/diagrams/component/runtime-core.mmd, and
for "Cargo Dependencies" to ./architecture/diagrams/cargo-dependencies.mmd (keep
the visible backtick filenames the same but update the markdown link hrefs).
Ensure you edit the table rows for C2, C3, and the Cargo Dependencies entry in
guides/architecture.md.
In `@clients/web/apps/docs/src/content/docs/es/guides/architecture.md`:
- Around line 121-124: The remaining table rows still use the old relative path
prefix "./diagrams/..." while C1 was updated to "./architecture/diagrams/...";
update the links for C2 (label "Contenedores del Runtime" ->
`container/runtime-containers.mmd`), C3 (label "Núcleo del Runtime" ->
`component/runtime-core.mmd`) and the "Dependencias de Cargo" row
(`cargo-dependencies.mmd`) so their hrefs use the same
"./architecture/diagrams/..." prefix as C1, ensuring all table entries
consistently point to "./architecture/diagrams/<file>.mmd".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: bd7872ca-d35c-4a54-8391-3b68ef21cec3
📒 Files selected for processing (2)
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: pr-checks
- GitHub Check: sonar
- GitHub Check: Cloudflare Pages
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
Deploying corvus with
|
| Latest commit: |
7d76295
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6a5097ba.corvus-42x.pages.dev |
| Branch Preview URL: | https://fix-404-errors.corvus-42x.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@clients/web/apps/docs/src/content/docs/es/guides/architecture.md`:
- Around line 121-124: In src/content/docs/es/guides/architecture.md update the
broken diagram links (e.g. ./architecture/diagrams/context/system-context.mmd,
./architecture/diagrams/container/runtime-containers.mmd,
./architecture/diagrams/component/runtime-core.mmd,
./architecture/diagrams/cargo-dependencies.mmd) so they point to the actual
shared built diagram location instead of the empty per-language source
directory; either move the diagram files into
src/content/docs/es/guides/architecture/diagrams/ (and the EN equivalent) or
change the table entries to the correct shared path (for example the
public/shared/guides/architecture/diagrams or absolute
/guides/architecture/diagrams/ location used in the build) so the links resolve
at runtime.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4fc90b4e-46a5-4c6f-b619-ea62b5b43bd7
📒 Files selected for processing (2)
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: sonar
- GitHub Check: pr-checks
- GitHub Check: pr-checks
- GitHub Check: Cloudflare Pages
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
🧠 Learnings (2)
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
Applied to files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/src/main.rs : Preserve CLI contract unless change is intentional and documented; prefer explicit errors over silent fallback for unsupported critical paths
Applied to files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.md
🔇 Additional comments (1)
clients/web/apps/docs/src/content/docs/en/guides/architecture.md (1)
120-123: Unable to complete request. No review comment was provided within<review_comment>tags for me to rewrite. Please provide the original review comment that needs to be verified and rewritten.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@lychee.toml`:
- Around line 27-28: Remove the root-relative diagram path exclusion entry
'^/guides/architecture/diagrams/.*' from the lychee configuration so CI link
validation will include those files; locate the exclusion array containing that
exact pattern and delete that pattern string (the entry matching
'^/guides/architecture/diagrams/.*') to ensure root_dir-resolved links under the
diagrams folder are validated.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 003b984c-466e-40c7-997e-6f3a803fab7e
📒 Files selected for processing (3)
clients/web/apps/docs/src/content/docs/en/guides/architecture.mdclients/web/apps/docs/src/content/docs/es/guides/architecture.mdlychee.toml
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: pr-checks
- GitHub Check: sonar
- GitHub Check: pr-checks
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/es/guides/architecture.mdclients/web/apps/docs/src/content/docs/en/guides/architecture.md
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/src/content/docs/es/guides/architecture.mdlychee.tomlclients/web/apps/docs/src/content/docs/en/guides/architecture.md
🧠 Learnings (2)
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
Applied to files:
clients/web/apps/docs/src/content/docs/es/guides/architecture.mdclients/web/apps/docs/src/content/docs/en/guides/architecture.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/src/main.rs : Preserve CLI contract unless change is intentional and documented; prefer explicit errors over silent fallback for unsupported critical paths
Applied to files:
clients/web/apps/docs/src/content/docs/en/guides/architecture.md
🔇 Additional comments (2)
clients/web/apps/docs/src/content/docs/es/guides/architecture.md (1)
121-124: Good fix for the shared diagram links.These entries now point at the shared
/guides/architecture/diagrams/...assets and stay aligned with the English guide.As per coding guidelines,
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes. For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.clients/web/apps/docs/src/content/docs/en/guides/architecture.md (1)
120-123: Good fix for the shared diagram links.These rows now use the shared
/guides/architecture/diagrams/...location and remain in sync with the Spanish guide.As per coding guidelines,
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes. For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
| # Root-relative diagram assets served from /public | ||
| '^/guides/architecture/diagrams/.*', |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Does lychee resolve root-relative local links like /guides/architecture/diagrams/context/system-context.mmdagainst the configuredroot_dirinlychee.toml, or is an explicit exclude still required?
💡 Result:
Lychee can resolve root-relative local links (paths starting with /, like /guides/...) against the configured root_dir—so you generally do not need an explicit exclude just for those links.
root_dir(inlychee.toml) is the config equivalent of--root-dir, and it tells lychee to resolve/foo/barby prefixing the root directory (e.g.,root_dir = "./site"makes/guides/xresolve to./site/guides/x). [1], [2], [3]
You’d still use exclude only if you intentionally don’t want those links checked or your on-disk folder layout doesn’t match the root-relative paths. [2]
🏁 Script executed:
cat -n lychee.toml | head -35Repository: dallay/corvus
Length of output: 1862
🏁 Script executed:
# Check if the diagram paths exist
fd -t f 'system-context\|diagrams' clients/web/apps/docs 2>/dev/null | head -20Repository: dallay/corvus
Length of output: 39
🏁 Script executed:
# Search for any diagram-related files more broadly
find clients/web/apps/docs -name "*diagram*" -o -name "*architecture*" 2>/dev/null | head -20Repository: dallay/corvus
Length of output: 577
🏁 Script executed:
# Check the actual structure of the public directory
ls -la clients/web/apps/docs/public/ 2>/dev/null || echo "Directory not found or empty"Repository: dallay/corvus
Length of output: 357
🏁 Script executed:
# Check if guides/architecture exists
ls -la clients/web/apps/docs/public/guides/architecture/ 2>/dev/null || echo "Not found"Repository: dallay/corvus
Length of output: 222
Remove the diagram path exclusion to maintain CI validation coverage.
With root_dir pointing to clients/web/apps/docs/public, lychee resolves root-relative links like /guides/architecture/diagrams/... directly against that directory. The diagrams folder exists there, so the exclusion at lines 27–28 is unnecessary and hides these links from CI checks—masking future typos that could become runtime 404s.
♻️ Proposed fix
- # Root-relative diagram assets served from /public
- '^/guides/architecture/diagrams/.*',📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Root-relative diagram assets served from /public | |
| '^/guides/architecture/diagrams/.*', |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@lychee.toml` around lines 27 - 28, Remove the root-relative diagram path
exclusion entry '^/guides/architecture/diagrams/.*' from the lychee
configuration so CI link validation will include those files; locate the
exclusion array containing that exact pattern and delete that pattern string
(the entry matching '^/guides/architecture/diagrams/.*') to ensure
root_dir-resolved links under the diagrams folder are validated.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
1 participant
This pull request updates the links to the system context diagram in the architecture documentation for both English and Spanish guides. The new links point to the correct location within the
architecture/diagrams/contextdirectory.Documentation fixes:
./architecture/diagrams/context/system-context.mmd../architecture/diagrams/context/system-context.mmd.