Skip to content

fix(docs): remove /docs URL prefix to eliminate route stutter - #780

Merged
saddlepaddle merged 1 commit into
mainfrom
fix-docs
Jan 16, 2026
Merged

saddlepaddle merged 1 commit into
mainfrom
fix-docs

Conversation

@saddlepaddle

@saddlepaddle saddlepaddle commented Jan 16, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Removed the /docs prefix from documentation URLs to eliminate the stuttering pattern (docs.superset.sh/docs/*).

Changes

  • Updated baseUrl from '/docs' to '/' in source.ts
  • Moved docs route from app/docs/ to app/(docs)/ route group
  • Relocated LLM route from llms.mdx/docs/ to llms.mdx/
  • Updated Next.js redirects to point to root-level paths
  • Updated MDX rewrite rules to match new structure
  • Fixed internal doc links in quick-start.mdx
  • Removed unnecessary (home) route group

URLs now work as

  • ✅ docs.superset.sh/setup-teardown-scripts (was docs.superset.sh/docs/setup-teardown-scripts)
  • ✅ docs.superset.sh/quick-start (was docs.superset.sh/docs/quick-start)
  • Old /docs/* URLs redirect automatically for backwards compatibility

Testing

  • ✅ Lint passed
  • ✅ Tests passed (1103 pass)
  • ✅ Typecheck passed
  • ✅ Build succeeded

Summary by CodeRabbit

  • Refactor
    • Simplified documentation URL structure by restructuring paths from "/docs" to root-level routing.
    • Updated navigation links and redirects to reflect the new routing scheme.

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

Changed docs URLs from docs.superset.sh/docs/* to docs.superset.sh/*

Changes:
- Updated baseUrl from '/docs' to '/' in source.ts
- Moved docs route from app/docs/ to app/(docs)/ route group
- Relocated LLM route from llms.mdx/docs/ to llms.mdx/
- Updated Next.js redirects to point to root-level paths
- Updated MDX rewrite rules to match new structure
- Fixed internal doc links in quick-start.mdx
- Removed unnecessary (home) route group

URLs now work as:
- ✅ docs.superset.sh/setup-teardown-scripts
- ✅ docs.superset.sh/quick-start
- Old /docs/* URLs redirect automatically for backwards compatibility
@coderabbitai

coderabbitai Bot commented Jan 16, 2026 •

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

This PR restructures the documentation routing by migrating the docs from /docs to the root / path. Changes include updating navigation links, Next.js redirects and rewrites, TypeScript route type annotations, removing the home route files, and adjusting the source base URL configuration.

Changes

Cohort / File(s) Summary
Navigation & Content
apps/docs/content/docs/quick-start.mdx
Updated navigation card links from /docs/overview and /docs/installation to /overview and /installation
Next.js Configuration
apps/docs/next.config.mjs
Updated redirect destination paths from /docs/quick-start to /quick-start and adjusted MDX rewrite rules from /docs/:path*.mdx patterns to root /:path*.mdx patterns
App Routes & Type Annotations
apps/docs/src/app/(docs)/[[...slug]]/page.tsx, apps/docs/src/app/(docs)/layout.tsx, apps/docs/src/app/llms.mdx/[[...slug]]/route.ts
Updated TypeScript PageProps and RouteContext type annotations to reflect new route paths (removed /docs prefix from template strings)
Home Route Removal
apps/docs/src/app/(home)/layout.tsx, apps/docs/src/app/(home)/page.tsx
Deleted home layout and page files that previously provided the root home page with a link to /docs
Source Configuration
apps/docs/src/lib/source.ts
Changed source baseUrl from /docs to / to align with new root-level documentation routing

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • superset-sh/superset#762: Modifies the home layout and page files along with docs app routing structure, indicating related architectural changes.
  • superset-sh/superset#759: Updates docs routing, MDX integration configuration, and source baseUrl in parallel with this PR's changes.

Poem

🐰 We hop along the path, so free,
From /docs down to root we'll be!
Links adjusted, routes made whole,
One simple structure is our goal. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removing the /docs URL prefix to eliminate route stutter, which aligns with the substantial refactoring across multiple files.
Description check ✅ Passed The description provides a clear summary of changes, includes a comprehensive changes list with specific file updates, shows expected outcomes with before/after URLs, and confirms testing results (lint, tests, typecheck, build).

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

✨ Finishing touches
  • 📝 Generate docstrings

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

github-actions Bot commented Jan 16, 2026 •

Copy link
Copy Markdown
Contributor

🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

  • ⚠️ Neon database branch
  • ✅ Electric Fly.io app

Thank you for your contribution! 🎉

@saddlepaddle
saddlepaddle merged commit d198357 into main Jan 16, 2026
13 checks passed
@Kitenite
Kitenite deleted the fix-docs branch January 18, 2026 22:16

This branch was previously deployed

1 inactive deployment
preview — 4bbfe3cf Deployed Jan 16, 2026 by saddlepaddle via Deploy API #890
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