Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: not found page #1476

Merged
merged 2 commits into from
Aug 26, 2024
Merged

Docs: not found page #1476

merged 2 commits into from
Aug 26, 2024

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Aug 26, 2024

Description

A missing/unstyled not found page can lead to confusion, user bounce rate and loss of traffic.

Changes

  • create not-found page for apps/web docs

Result

Before

Screenshot 2024-08-26 at 14 07 24

After

Screenshot 2024-08-26 at 14 06 53

Summary by CodeRabbit

  • New Features
    • Introduced a user-friendly 404 error page that provides clear feedback and navigation options when a page is not found.
  • Improvements
    • Streamlined the component by removing unused imports, enhancing performance and maintainability.

@SutuSebastian SutuSebastian added 📚 documentation Improvements or additions to documentation 🚀 enhancement New feature or request labels Aug 26, 2024
@SutuSebastian SutuSebastian self-assigned this Aug 26, 2024
Copy link

changeset-bot bot commented Aug 26, 2024

⚠️ No Changeset found

Latest commit: 7386929

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Aug 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 26, 2024 11:10am
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 26, 2024 11:10am

Copy link
Contributor

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes involve the removal of unused imports from the page.tsx file, specifically the Footer and Image components. Additionally, a new NotFoundPage component has been introduced in the not-found.tsx file to handle 404 errors, featuring a structured layout with navigation and messaging for users.

Changes

Files Change Summary
apps/web/app/docs/[[...slug]]/page.tsx Removed unused imports: Footer from flowbite-react, Image from next/image.
apps/web/app/not-found.tsx Introduced NotFoundPage component for 404 error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NotFoundPage
    participant HomeNavbar
    participant MainFooter

    User->>NotFoundPage: Access non-existent page
    NotFoundPage->>HomeNavbar: Display navigation
    NotFoundPage->>User: Show "404 - Page Not Found" message
    NotFoundPage->>MainFooter: Display footer
Loading

🐇 In fields of code, I hop with glee,
Removing clutter, oh so free!
A new page greets when paths go wrong,
With guidance clear, we all belong.
Hooray for changes, fresh and bright,
Let’s bounce ahead into the light! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e204ee4 and 7386929.

Files selected for processing (2)
  • apps/web/app/docs/[[...slug]]/page.tsx (1 hunks)
  • apps/web/app/not-found.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • apps/web/app/docs/[[...slug]]/page.tsx
Additional context used
GitHub Check: 🕵 Lint
apps/web/app/not-found.tsx

[warning] 9-9:
Classname 'text-primary-600' is not a Tailwind CSS class!

Additional comments not posted (3)
apps/web/app/not-found.tsx (3)

1-2: LGTM!

The import statements are correct and necessary for the component.

The code changes are approved.


9-9: Verify Tailwind CSS class.

The class text-primary-600 is not a standard Tailwind CSS class. Verify if it is a custom class or correct it if it is a typo.

Ensure that text-primary-600 is defined in your Tailwind CSS configuration or replace it with a valid Tailwind CSS class.

Tools
GitHub Check: 🕵 Lint

[warning] 9-9:
Classname 'text-primary-600' is not a Tailwind CSS class!


4-17: LGTM!

The NotFoundPage component is well-structured and correctly implements a 404 error page.

The code changes are approved.

Tools
GitHub Check: 🕵 Lint

[warning] 9-9:
Classname 'text-primary-600' is not a Tailwind CSS class!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation 🚀 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant