Skip to content

fix(docs): rutas relativas en docs - #33

Merged
kattsushi merged 2 commits into
masterfrom
fix/docs-relative-links
Feb 7, 2026
Merged

kattsushi merged 2 commits into
masterfrom
fix/docs-relative-links

Conversation

@kattsushi

@kattsushi kattsushi commented Feb 7, 2026 •

Copy link
Copy Markdown
Contributor

Estandariza enlaces internos a rutas relativas para evitar 404 en GitHub Pages bajo /effectify/.\n\nCambios principales:\n- Ajustes en universal/getting-started.md e índices de secciones.\n- Verificación de ausencia de enlaces absolutos (/](/), href="/, link: /).\n\nPor favor revisa que la navegación funcione en https://devx-op.github.io/effectify/.

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation homepage with expanded Quick Start guides for React, SolidJS, and Node.js Backend.
    • Added new navigation cards and links in the Example Applications section.
    • Updated internal documentation links across all platform sections for improved navigation consistency.

@coderabbitai

coderabbitai Bot commented Feb 7, 2026 •

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Documentation links converted from absolute paths with leading slashes to relative paths across sidebar configuration and content pages in backend, react, solid, and universal documentation sections. Navigation targets remain the same but use relative path resolution instead.

Changes

Cohort / File(s) Summary
Sidebar Configuration
apps/docs/astro.config.ts
Updated navigation link paths from absolute to relative format for ReactJs, SolidJs, Backend, and Universal sections.
Root Documentation
apps/docs/src/content/docs/index.mdx
Converted hero action links and platform/quick-start card links from absolute to relative paths; reorganized platform cards with indentation adjustments and added new Universal exploration link and Backend Quick Start entry.
Backend Documentation
apps/docs/src/content/docs/backend/getting-started.md, backend/index.mdx, backend/installation.md
Converted three backend package links from absolute to relative paths; reformatted service signature declarations across multiple lines without semantic changes.
React Documentation
apps/docs/src/content/docs/react/getting-started.md, react/index.mdx, react/installation.md
Updated all Next Steps and Learn more links from absolute to relative paths for three package references.
Solid Documentation
apps/docs/src/content/docs/solid/getting-started.md, solid/index.mdx, solid/installation.md
Converted Learn more and Next Steps links from absolute paths to relative paths across Solid documentation pages.
Universal Documentation
apps/docs/src/content/docs/universal/getting-started.md, universal/index.mdx
Changed five markdown hyperlinks from absolute root-based URLs to relative paths for packages and concept pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Hop through the docs with paths so fine,
From /absolute to relative line,
No leading slash, just cleaner routes,
Our bunny knows the sweetest foots! 🌙✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix(docs): rutas relativas en docs' clearly refers to the main change: converting documentation links from absolute to relative paths, which is comprehensively implemented across all modified files.
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 docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/docs-relative-links

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

@nx-cloud

nx-cloud Bot commented Feb 7, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit b06d27c

Command Status Duration Result
nx affected --target=test --base=87c40a1ce45893... ✅ Succeeded 10s View ↗
nx affected --target=build --base=87c40a1ce4589... ✅ Succeeded 16s View ↗
nx affected --target=typecheck --base=origin/ma... ✅ Succeeded <1s View ↗
nx affected --target=lint --base=origin/master ... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-02-07 21:44:41 UTC

@kattsushi
kattsushi merged commit 2cc077c into master Feb 7, 2026
6 of 7 checks passed

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (4)
apps/docs/src/content/docs/universal/index.mdx (1)

14-35: ⚠️ Potential issue | 🟠 Major

Fix relative links to avoid duplicated /universal/ segments.

From /universal/, links like universal/packages/... resolve to /universal/universal/.... Use section-relative paths instead.

🔧 Suggested fix
-    [Learn more →](universal/packages/chat-domain/)
+    [Learn more →](packages/chat-domain/)

-    [Learn more →](universal/packages/shared-types/)
+    [Learn more →](packages/shared-types/)

-  [Get Started →](universal/getting-started/)
+  [Get Started →](getting-started/)
apps/docs/src/content/docs/universal/getting-started.md (1)

526-532: ⚠️ Potential issue | 🟠 Major

Adjust Next Steps links to be relative to /universal/getting-started/.

Current paths will resolve one level too deep.

🔧 Suggested fix
-- [Chat Domain](universal/packages/chat-domain/) - Learn chat domain logic
-- [Shared Types](universal/packages/shared-types/) - Explore common types
-- [Universal Concepts](universal/concepts/) - Dive deeper into patterns
+- [Chat Domain](../packages/chat-domain/) - Learn chat domain logic
+- [Shared Types](../packages/shared-types/) - Explore common types
+- [Universal Concepts](../concepts/) - Dive deeper into patterns
apps/docs/src/content/docs/backend/getting-started.md (1)

513-519: ⚠️ Potential issue | 🟠 Major

Fix Next Steps links to avoid duplicated /backend/ segments.

Use paths relative to /backend/getting-started/.

🔧 Suggested fix
-- [Node Better Auth](backend/packages/node-better-auth/) - Learn authentication patterns
-- [Node Auth App](backend/packages/node-auth-app/) - Explore the complete auth service
-- [Backend Reference](backend/reference/) - Dive into the API documentation
+- [Node Better Auth](../packages/node-better-auth/) - Learn authentication patterns
+- [Node Auth App](../packages/node-auth-app/) - Explore the complete auth service
+- [Backend Reference](../reference/) - Dive into the API documentation
apps/docs/src/content/docs/backend/index.mdx (1)

14-35: ⚠️ Potential issue | 🟠 Major

Use section-relative links in the Backend index.

From /backend/, backend/... resolves to /backend/backend/....

🔧 Suggested fix
-    [Learn more →](backend/packages/node-better-auth/)
+    [Learn more →](packages/node-better-auth/)

-    [Learn more →](backend/packages/node-auth-app/)
+    [Learn more →](packages/node-auth-app/)

-  [Get Started →](backend/getting-started/)
+  [Get Started →](getting-started/)
🤖 Fix all issues with AI agents
In `@apps/docs/src/content/docs/backend/installation.md`:
- Around line 574-579: In the "Next Steps" list in installation.md the link
targets include a leading "backend/" which causes URLs to resolve to
/backend/backend/...; update the four links inside the Next Steps
block—specifically the link targets for Getting Started, Node Better Auth, Node
Auth App, and Backend Reference—by removing the initial "backend/" prefix so
they become relative (e.g. change "backend/getting-started/" to
"getting-started/", "backend/packages/node-better-auth/" to
"packages/node-better-auth/", etc.) ensuring correct resolution from the current
docs path.

Comment on lines 574 to +579
## Next Steps

- [Getting Started Guide](/backend/getting-started/) - Learn the basics
- [Node Better Auth](/backend/packages/node-better-auth/) - Explore authentication
- [Node Auth App](/backend/packages/node-auth-app/) - Complete auth service
- [Backend Reference](/backend/reference/) - API documentation
- [Getting Started Guide](backend/getting-started/) - Learn the basics
- [Node Better Auth](backend/packages/node-better-auth/) - Explore authentication
- [Node Auth App](backend/packages/node-auth-app/) - Complete auth service
- [Backend Reference](backend/reference/) - API documentation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Fix Next Steps links to avoid /backend/backend/... resolution.

🔧 Suggested fix
-- [Getting Started Guide](backend/getting-started/) - Learn the basics
-- [Node Better Auth](backend/packages/node-better-auth/) - Explore authentication
-- [Node Auth App](backend/packages/node-auth-app/) - Complete auth service
-- [Backend Reference](backend/reference/) - API documentation
+- [Getting Started Guide](../getting-started/) - Learn the basics
+- [Node Better Auth](../packages/node-better-auth/) - Explore authentication
+- [Node Auth App](../packages/node-auth-app/) - Complete auth service
+- [Backend Reference](../reference/) - API documentation
🤖 Prompt for AI Agents
In `@apps/docs/src/content/docs/backend/installation.md` around lines 574 - 579,
In the "Next Steps" list in installation.md the link targets include a leading
"backend/" which causes URLs to resolve to /backend/backend/...; update the four
links inside the Next Steps block—specifically the link targets for Getting
Started, Node Better Auth, Node Auth App, and Backend Reference—by removing the
initial "backend/" prefix so they become relative (e.g. change
"backend/getting-started/" to "getting-started/",
"backend/packages/node-better-auth/" to "packages/node-better-auth/", etc.)
ensuring correct resolution from the current docs path.

kattsushi added a commit that referenced this pull request Mar 15, 2026
* fix(docs): use relative internal links and remove leading slashes; keep site/domain + base subpath

* fix(docs): usar rutas relativas para enlaces internos en GitHub Pages
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