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

621-feat: Change js en docs link #622

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Conversation

KristiBo
Copy link
Collaborator

@KristiBo KristiBo commented Oct 25, 2024

What type of PR is this? (select all that apply)

  • πŸ• Feature
  • πŸ› Bug Fix
  • 🚧 Breaking Change
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ“ Documentation Update

Description

Related Tickets & Documents

Added/updated tests?

  • πŸ‘Œ Yes
  • πŸ™…β€β™‚οΈ No, because they aren't needed
  • πŸ™‹β€β™‚οΈ No, because I need help

Summary by CodeRabbit

  • New Features

    • Introduced a new link to the English documentation for enhanced user access.
    • Updated the communication component to conditionally display the new documentation link based on the course type.
  • Bug Fixes

    • Replaced a hardcoded link with a dynamic link for improved accuracy in the UI.

@KristiBo KristiBo self-assigned this Oct 25, 2024
@github-actions github-actions bot changed the title 621-feat: Change docs link for jsfe-en 621-feat: Change js en docs link Oct 25, 2024
@KristiBo KristiBo added feature New feature or request preview and removed preview labels Oct 25, 2024
Copy link

Lighthouse Report:

  • Performance: 97 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

@Quiddlee Quiddlee marked this pull request as ready for review October 25, 2024 20:03
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

πŸ“ Walkthrough

Walkthrough

The changes in this pull request involve the addition of a new constant RS_DOCS_EN_LINK that points to the English documentation URL. This constant is introduced in the dev-data/communication.data.ts file and is subsequently exported from the dev-data/index.ts file. Additionally, the src/widgets/communication/ui/communication.tsx file is modified to use this new link in the LinkCustom component, replacing a hardcoded link based on a conditional check related to the course name.

Changes

File Path Change Summary
dev-data/communication.data.ts Added constant RS_DOCS_EN_LINK with English documentation link.
dev-data/index.ts Exported RS_DOCS_EN_LINK from ./communication.data.
src/widgets/communication/ui/communication.tsx Modified logic to use RS_DOCS_EN_LINK in LinkCustom component.

Assessment against linked issues

Objective Addressed Explanation
Change the link for JS/FE EN to https://docs.rs.school/#/en/ (#621) βœ…

Suggested reviewers

  • dzmitry-varabei
  • andron13
  • natanchik
  • SpaNb4

πŸ“œ Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

πŸ“₯ Commits

Files that changed from the base of the PR and between 1d7b8aa and b2b928a.

πŸ“’ Files selected for processing (3)
  • dev-data/communication.data.ts (1 hunks)
  • dev-data/index.ts (1 hunks)
  • src/widgets/communication/ui/communication.tsx (3 hunks)
πŸ”‡ Additional comments (5)
dev-data/communication.data.ts (1)

2-2: LGTM! The constant addition meets the requirements.

The new RS_DOCS_EN_LINK constant is properly exported and follows the established naming conventions.

Let's verify the constant usage:

βœ… Verification successful

Constant is correctly used and integrated

The RS_DOCS_EN_LINK constant is properly:

  • Exported from communication.data.ts
  • Re-exported through index.ts
  • Used in communication.tsx for conditional rendering based on course type
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the new constant is used correctly
# Test: Search for RS_DOCS_EN_LINK usage
rg "RS_DOCS_EN_LINK"

Length of output: 346

dev-data/index.ts (1)

15-15: LGTM! Export addition follows best practices.

The new export is correctly placed and follows the established naming convention.

src/widgets/communication/ui/communication.tsx (3)

13-13: LGTM: Import added correctly

The RS_DOCS_EN_LINK constant is properly imported from the data module.


53-53: LGTM: Clear conditional logic

The rsDocsHref assignment uses clear conditional logic to determine the appropriate documentation link based on the course type.


95-97: LGTM: Link implementation

The LinkCustom component correctly uses the new rsDocsHref variable to display the appropriate documentation link.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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.

@SpaNb4 SpaNb4 merged commit 9fbb7bb into main Oct 26, 2024
9 checks passed
@SpaNb4 SpaNb4 deleted the feat/621-change-js-en-docs-link branch October 26, 2024 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[JS/FE En Course] Change the link to documentation
5 participants