Skip to content

[Docs] Fix dead links on api overview page#1115

Merged
madster456 merged 2 commits intodevfrom
docs/dead-link
Jan 16, 2026
Merged

[Docs] Fix dead links on api overview page#1115
madster456 merged 2 commits intodevfrom
docs/dead-link

Conversation

@madster456
Copy link
Copy Markdown
Collaborator

@madster456 madster456 commented Jan 16, 2026

Summary by CodeRabbit

  • Documentation
    • Updated API documentation links from Next-specific paths to unified documentation paths for improved navigation and consistency across documentation
    • Added lastModified metadata field to documentation pages for enhanced content version tracking and visibility of recent updates
    • Removed outdated documentation cross-references from support section while preserving active community support links

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
stack-backend Building Building Preview, Comment Jan 16, 2026 9:23pm
stack-dashboard Building Building Preview, Comment Jan 16, 2026 9:23pm
stack-demo Ready Ready Preview, Comment Jan 16, 2026 9:23pm
stack-docs Building Building Preview, Comment Jan 16, 2026 9:23pm

@madster456 madster456 merged commit 01c890d into dev Jan 16, 2026
14 of 18 checks passed
@madster456 madster456 deleted the docs/dead-link branch January 16, 2026 21:24
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 16, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Updated documentation file docs/templates-api/overview.mdx by adding lastModified field to metadata, replacing Next-path links with standard paths, and removing a concepts link from the Help section.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/templates-api/overview.mdx
Added lastModified field to YAML front matter; replaced Getting Started link path from docs/next/getting-started/setup to docs/getting-started/setup; removed Concepts link from Need Help section

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Bouncing through docs with glee,
Links were trimmed, now clean and free,
Paths simplified, no "next" to see,
Metadata logged—hopping with spree!


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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jan 16, 2026

Greptile Summary

This PR fixes dead documentation links in the API overview template page:

  • Updated the Getting Started Guide link from /docs/next/getting-started/setup to /docs/getting-started/setup, aligning it with the canonical URL format used throughout the codebase
  • Removed the dead link to the Concepts section (/docs/next/concepts) which pointed to a non-existent index page
  • Added lastModified frontmatter field for tracking documentation updates

The changes are straightforward link maintenance that improves documentation navigation reliability.

Confidence Score: 5/5

  • This is a safe documentation-only change that fixes broken links without affecting any application logic
  • The changes are limited to a single MDX documentation file, fixing link paths to match the established URL patterns in the codebase. No code logic, security implications, or breaking changes are involved.
  • No files require special attention

Important Files Changed

Filename Overview
docs/templates-api/overview.mdx Fixed dead link to Getting Started Guide by removing legacy /docs/next/ prefix, removed dead link to Concepts section, and added lastModified frontmatter field

Sequence Diagram

sequenceDiagram
    participant User as User
    participant Docs as Documentation Site
    participant Template as templates-api/overview.mdx
    participant Build as Build Process
    participant Output as content/api/overview.mdx

    Note over Template: PR Change: Fix dead links
    Template->>Build: Template file modified
    Build->>Output: Copy template to content/api/
    User->>Docs: Navigate to API Reference
    Docs->>Output: Serve overview.mdx
    User->>Docs: Click "Getting Started Guide"
    Docs->>Docs: Navigate to /docs/getting-started/setup
    Note over Docs: Link now works correctly
Loading

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