Skip to content

feat(docs): add custom docs 404 page#182

Open
almeidazs wants to merge 1 commit into
getpaykit:mainfrom
almeidazs:fix/docs-404
Open

feat(docs): add custom docs 404 page#182
almeidazs wants to merge 1 commit into
getpaykit:mainfrom
almeidazs:fix/docs-404

Conversation

@almeidazs
Copy link
Copy Markdown

@almeidazs almeidazs commented May 18, 2026

This adds a docs-specific 404 page so missing routes under /docs no longer fall back to the generic site-wide not found screen.

I kept it inside the docs layout and reused the existing empty-state components, with quick links back to /docs/get-started and /.

Validation:

  • bun run typecheck in apps/web
  • env RESEND_API_KEY=dummy bun run build in apps/web

Closes #70

Summary by CodeRabbit

  • New Features
    • Added a styled documentation not-found page with navigation buttons to the getting started guide and home, plus a helpful note guiding users to use the sidebar or search functionality.

Review Change Stack

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 18, 2026

@almeidazs is attempting to deploy a commit to the maxktz Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 48e1eedb-8382-4e90-a810-32a349c20e2a

📥 Commits

Reviewing files that changed from the base of the PR and between 55a0bda and 409da27.

📒 Files selected for processing (1)
  • apps/web/src/app/docs/not-found.tsx

📝 Walkthrough

Walkthrough

New 404 page component added to the docs section that displays a styled "page not found" UI with navigation buttons linking back to the docs get-started guide and home page, plus a helper note encouraging users to use sidebar/search.

Changes

Docs 404 Page

Layer / File(s) Summary
DocsNotFound page component
apps/web/src/app/docs/not-found.tsx
New page component with imports, Empty UI presentation (icon, title, explanatory text), two navigation buttons (/docs/get-started and /), and a small instructional note with ArrowLeft icon.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

  • None additional (issue #70 is already linked to this PR and directly addressed by this change).

Poem

🐰 A page not found, but fear not, dear friend,
The docs now guide you round the bend,
With buttons bright and arrows true,
Back to start, or home, it's up to you! 📖✨

🚥 Pre-merge checks | ✅ 4 | ❌ 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 (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat(docs): add custom docs 404 page' is clear, specific, and directly summarizes the main change of adding a custom 404 page for the docs section.
Linked Issues check ✅ Passed The PR successfully implements the custom 404 page for the /docs route as required by issue #70, with proper component creation and navigation links.
Out of Scope Changes check ✅ Passed All changes are directly related to implementing the docs-specific 404 page; no out-of-scope modifications detected.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

@almeidazs almeidazs marked this pull request as ready for review May 18, 2026 12:23
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.

feat(docs): custom 404 for /docs

1 participant