Skip to content

fix(docs): update architecture diagram links and overview references#186

Merged
yacosta738 merged 1 commit into
mainfrom
docs/architecture-link-fixes
Mar 10, 2026
Merged

fix(docs): update architecture diagram links and overview references#186
yacosta738 merged 1 commit into
mainfrom
docs/architecture-link-fixes

Conversation

@yacosta738
Copy link
Copy Markdown
Contributor

This pull request updates the architecture documentation in both English and Spanish to fix and simplify the links to diagram files and overview pages. The main goal is to ensure that all diagram and overview references point to the correct locations, improving navigation and consistency across the documentation.

Documentation link updates:

  • Updated all architecture diagram links in both architecture.md files to remove the architecture/diagrams/ prefix, so they now point to the correct relative ./diagrams/ directory. [1] [2]
  • Changed the "Architecture Index"/"Visión General de la Arquitectura" overview links to point to ./overview instead of ./architecture/overview.md for consistency and to avoid broken links. [1] [2]

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: e56a49ae-22f6-4fe7-bd32-f6a73fa69f47

📥 Commits

Reviewing files that changed from the base of the PR and between f2d74a1 and 3f045de.

📒 Files selected for processing (2)
  • clients/web/apps/docs/src/content/docs/en/guides/architecture.md
  • clients/web/apps/docs/src/content/docs/es/guides/architecture.md
📜 Recent 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). (2)
  • GitHub Check: pr-checks
  • GitHub Check: sonar
🧰 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.md
  • clients/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.md
  • clients/web/apps/docs/src/content/docs/es/guides/architecture.md
🪛 LanguageTool
clients/web/apps/docs/src/content/docs/es/guides/architecture.md

[grammar] ~126-~126: Corrige la mayúscula.
Context: ...pendencies.mmd` | Ver Visión General de la Arquitectura para má...

(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)


[grammar] ~126-~126: Corrige la mayúscula.
Context: ...` | Ver Visión General de la Arquitectura para más detalles sobre có...

(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)


[grammar] ~126-~126: Elimina la palabra o signo.
Context: ..../overview) para más detalles sobre cómo visualizarlos.

(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_SPACE)

🔇 Additional comments (2)
clients/web/apps/docs/src/content/docs/es/guides/architecture.md (1)

121-127: Links look correct and stay in parity with EN.

The new ./diagrams/... targets match the published diagram paths, and the ./overview link keeps the Spanish page aligned with the English guide. As per coding guidelines, "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-125: Relative link cleanup is consistent and technically sound.

These paths now match the docs layout shown in the published diagram files, and the overview link stays consistent with the ES page. As per coding guidelines, "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."


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated architecture documentation with corrected internal links and improved navigation references. Fixed path references throughout the guides and improved table formatting for better readability. Enhanced consistency and structure across both English and Spanish language versions of the documentation to provide a better user experience when accessing architecture materials and resources.

Walkthrough

Updates C4 diagram link paths in English and Spanish architecture guides by removing the architecture/ directory prefix from diagram references and updating the overview link path from ./architecture/overview.md to ./overview.

Changes

Cohort / File(s) Summary
Architecture Guide Link Updates
clients/web/apps/docs/src/content/docs/en/guides/architecture.md, clients/web/apps/docs/src/content/docs/es/guides/architecture.md
Removed architecture/ prefix from C4 diagram paths in the architecture table (e.g., ./architecture/diagrams/..../diagrams/...) and updated the overview reference link from ./architecture/overview.md to ./overview in both language versions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

area:docs, area:web

Suggested reviewers

  • yuniel-acosta
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commit style with 'fix' prefix and clearly describes the main changes to architecture documentation links.
Description check ✅ Passed The description provides clear context and details about the changes, including specific file paths and the rationale for link corrections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/architecture-link-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

✅ Contributor Report

User: @yacosta738
Status: Passed (12/13 metrics passed)

Metric Description Value Threshold Status
PR Merge Rate PRs merged vs closed 88% >= 30%
Repo Quality Repos with ≥100 stars 0 >= 0
Positive Reactions Positive reactions received 9 >= 1
Negative Reactions Negative reactions received 0 <= 5
Account Age GitHub account age 3056 days >= 30 days
Activity Consistency Regular activity over time 108% >= 0%
Issue Engagement Issues with community engagement 0 >= 0
Code Reviews Code reviews given to others 398 >= 0
Merger Diversity Unique maintainers who merged PRs 2 >= 0
Repo History Merge Rate Merge rate in this repo 91% >= 0%
Repo History Min PRs Previous PRs in this repo 139 >= 0
Profile Completeness Profile richness (bio, followers) 90 >= 0
Suspicious Patterns Spam-like activity detection 1 N/A

Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-03-10 to 2026-03-10

@sonarqubecloud
Copy link
Copy Markdown

@yacosta738 yacosta738 merged commit febd998 into main Mar 10, 2026
18 checks passed
@yacosta738 yacosta738 deleted the docs/architecture-link-fixes branch March 10, 2026 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant