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

Update: Make 404 pages support multiple languages, and increase the length of the article summary #417

Merged
merged 8 commits into from
Aug 31, 2024

Conversation

FrederickBun
Copy link
Contributor

@FrederickBun FrederickBun commented Aug 21, 2024

Previously, 404 pages were only in Chinese, but now translation has been added to make them support all languages of the topic
Before, the article summary was very small, resulting in very little information, now increased to 300, the content will be more rich

Summary by CodeRabbit

  • New Features

    • Added "Go Back Home" navigation option in English, Japanese, Simplified Chinese, and Traditional Chinese for improved localization.
    • Updated the 404 error page with clearer navigation options, including a link to return to the previous page and a new option to go back to the homepage.
    • Increased content preview length in post display for better context before reading full articles.
  • Bug Fixes

    • Improved clarity and functionality of navigation links on the 404 error page.

…ength of the article summary

Previously, 404 pages were only in Chinese, but now translation has been added to make them support all languages of the topic
Before, the article summary was very small, resulting in very little information, now increased to 300, the content will be more rich
Copy link

coderabbitai bot commented Aug 21, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve the addition of a new localization key for "Go Back Home" in multiple language files, enhancing the application's multilingual support. Additionally, the 404 error page template has been updated to improve navigation options, and the truncation length for post content in the home content template has been increased from 128 to 300 characters, allowing for more content visibility.

Changes

File Change Summary
languages/en.yml New entry go-back-home: Go Back Home added.
languages/ja.yml New entry go-back-home: トップページに戻ります added.
languages/zh-CN.yml New entry go-back-home: 回到首页 added.
languages/zh-TW.yml New entry go-back-home: 回到首頁 added.
layout/_partials/404-template.ejs Link text changed from "Go Back Home" to "Return to previous page"; added new paragraph for returning to homepage.
layout/_partials/home-content.ejs Truncation length increased from 128 to 300 characters for post content preview.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomePage
    participant PostContent

    User->>HomePage: Visit Home
    HomePage->>PostContent: Display Posts
    PostContent->>User: Show Post Preview (300 characters)
Loading

🐰 Hopping through the code, oh what a sight,
New phrases and links make navigation bright!
From home to post, with a joyful leap,
Our users find paths, their journeys to keep.
With every change, we dance and play,
In the world of code, we hop all day! 🐇✨


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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@FrederickBun
Copy link
Contributor Author

@coderabbitai review

Copy link

coderabbitai bot commented Aug 26, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@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 3d24971 and 66d3a09.

Files selected for processing (6)
  • languages/en.yml (1 hunks)
  • languages/ja.yml (1 hunks)
  • languages/zh-CN.yml (1 hunks)
  • languages/zh-TW.yml (1 hunks)
  • layout/_partials/404-template.ejs (1 hunks)
  • layout/_partials/home-content.ejs (1 hunks)
Files skipped from review due to trivial changes (4)
  • languages/en.yml
  • languages/ja.yml
  • languages/zh-CN.yml
  • languages/zh-TW.yml
Additional comments not posted (3)
layout/_partials/404-template.ejs (2)

6-7: LGTM!

The change improves user navigation by allowing users to return to the previous page instead of always going back to the homepage.

The code changes are approved.


9-13: LGTM!

The change provides an additional navigation option for users, improving the overall user experience on the 404 page.

The code changes are approved.

layout/_partials/home-content.ejs (1)

46-46: LGTM!

The change allows for a longer preview of the post content, providing users with more context before they decide to read the full article.

The code changes are approved.

Copy link
Owner

@EvanNotFound EvanNotFound left a comment

Choose a reason for hiding this comment

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

Please fix the code here

Copy link
Owner

Choose a reason for hiding this comment

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

The code will not run correctly as the git conflict is not solved

Copy link
Owner

@EvanNotFound EvanNotFound left a comment

Choose a reason for hiding this comment

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

Should use __("go-back-home") helper function in order to correctly display i18n title

@FrederickBun
Copy link
Contributor Author

Should use helper function in order to correctly display i18n title__("go-back-home")

OK

@FrederickBun
Copy link
Contributor Author

FrederickBun commented Aug 31, 2024

Should use helper function in order to correctly display i18n title__("go-back-home")

and how can i do

@EvanNotFound EvanNotFound merged commit 3b1a14e into EvanNotFound:dev Aug 31, 2024
1 check failed
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.

2 participants