Skip to content

Added corrections #2895

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

Conversation

NishantSinghhhhh
Copy link

@NishantSinghhhhh NishantSinghhhhh commented Jan 24, 2025

What kind of change does this PR introduce?
Bugfix

Issue Number:

Fixes

Snapshots/Videos:

Summary

Understood. I will follow the Concise Mode instructions in responding to your request.

To address the image cut-off issue:

  1. Wrap the image in a container with overflow: hidden to ensure the entire image is visible.
  2. Set the image's height to auto to allow it to scale proportionally.
  3. Use object-fit: contain to fit the image within the container.

This should resolve the cut-off problem on wide screens. Let me know if you have any other questions!

Does this PR introduce a breaking change?
No

Summary by CodeRabbit

  • Documentation

  • Style

    • Added .image-container CSS class to manage image display and sizing
    • Implemented responsive image handling with object-fit: contain
  • Chores

    • Removed comments from the index.tsx file for cleaner code structure

Signed-off-by: NishantSinghhhhh <[email protected]>
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

This pull request introduces modifications to the Docusaurus documentation configuration and styling. The changes include updating the navigation configuration in docusaurus.config.ts by changing the "Docs" label to "General" and adding an external href link. In the HeaderHero component, the image rendering has been restructured by wrapping the image in a new container div. Additionally, a new CSS class .image-container has been added to custom.css to provide responsive image styling.

Changes

File Change Summary
docs/docusaurus.config.ts - Changed navbar item label from "Docs" to "General"
- Added href property linking to "https://docs.talawa.io/"
docs/src/components/layout/HeaderHero.tsx - Replaced direct <img> with <div class="image-container">
- Commented out srcSet attribute
docs/src/css/custom.css - Added new .image-container class
- Defined responsive image styling with 100% width and object-fit: contain

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes
  • duplixx

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8deae66 and 120747e.

📒 Files selected for processing (1)
  • docs/src/pages/index.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/src/pages/index.tsx
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop-postgres@3af2495). Learn more about missing BASE report.

Additional details and impacted files
@@                 Coverage Diff                 @@
##             develop-postgres    #2895   +/-   ##
===================================================
  Coverage                    ?   39.85%           
===================================================
  Files                       ?      453           
  Lines                       ?    33203           
  Branches                    ?      385           
===================================================
  Hits                        ?    13234           
  Misses                      ?    19969           
  Partials                    ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3af2495 and 8deae66.

📒 Files selected for processing (3)
  • docs/docusaurus.config.ts (1 hunks)
  • docs/src/components/layout/HeaderHero.tsx (1 hunks)
  • docs/src/css/custom.css (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (2)
docs/docusaurus.config.ts (1)

70-71: Verify that external linking is intentional.
Including both "type": "docSidebar" and "href" in the same item is somewhat unconventional and may override the docSidebar functionality. If linking to an external site is indeed intended, consider removing the type and sidebarId properties.

docs/src/css/custom.css (1)

1268-1278: Great approach to fix image cut-off issues.
Using overflow: hidden and object-fit: contain ensures the entire image is visible without distortion. This looks good!

@NishantSinghhhhh
Copy link
Author

@palisadoes , I have added the changes you have pointed out in [https://github.com//pull/2878#issuecomment-2605398322]

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 24, 2025
@palisadoes
Copy link
Contributor

Please merge with the latest upstream. There have been significant changes

Signed-off-by: NishantSinghhhhh <[email protected]>
Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@NishantSinghhhhh
Copy link
Author

@palisadoes, I have already pulled all the code from develop-postgres, so it is fully up-to-date.

@varshith257 varshith257 added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Jan 24, 2025
src={useBaseUrl("img/image-01.png")}
alt="Talawa member management software interface showcase"
loading="lazy"
// srcSet={`${useBaseUrl("img/image-01.png")} 1x, ${useBaseUrl("img/[email protected]")} 2x`}
Copy link
Member

Choose a reason for hiding this comment

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

Uncomment?

Copy link
Author

Choose a reason for hiding this comment

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

What I saw on localhost , the image was not rendering when both src and srcset were present ,

After srcset was commented out , the image rendered , if you want me to uncomment, I can do so

@palisadoes
Copy link
Contributor

I got mixed up with Admin.

@palisadoes palisadoes merged commit 6c201af into PalisadoesFoundation:develop-postgres Jan 24, 2025
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants