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

fix: Created LEARN.md #335

Merged
merged 6 commits into from
May 26, 2024
Merged

Conversation

Meetjain1
Copy link
Contributor

@Meetjain1 Meetjain1 commented May 25, 2024

Related Issue

closes #334

Description

created LEARN.md file from scratch.

Summary by CodeRabbit

  • Documentation
    • Updated LEARN.md file to introduce the Palettegram Website project, tech stack, learning resources, and FAQ section.

Copy link

vercel bot commented May 25, 2024

@Meetjain1 is attempting to deploy a commit to the Sanchit Bajaj's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 25, 2024

Warning

Rate Limit Exceeded

@Meetjain1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 42 minutes and 38 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 5921dd1 and 33f1cca.

Walkthrough

The LEARN.md file has been added to the Palettegram Website project, offering an introduction to the project's purpose, tech stack (Next.js, TypeScript, Tailwind CSS, Appwrite), learning resources for these technologies, and a FAQ section. This addition aims to provide guidance to new users and contributors by presenting a comprehensive overview and educational content related to the project.

Changes

File Change Summary
LEARN.md Added a new file introducing the Palettegram Website project, detailing its purpose, tech stack, learning resources, and a FAQ section.

Assessment against linked issues

Objective Addressed Explanation
Add a LEARN.md file to provide guidance, tutorials, or educational content related to the repository (#334)

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

@github-actions github-actions bot added title needs formatting Title of issue or pull request does not match the guidelines wait for reviewers and removed title needs formatting Title of issue or pull request does not match the guidelines labels May 25, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Great job, @Meetjain1! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project. Keep being the part of the community!

'We will promptly review your changes and offer feedback. Keep up the excellent work!
Kindly remember to check our Contributing Guidelines'

@github-actions github-actions bot added the title needs formatting Title of issue or pull request does not match the guidelines label May 25, 2024
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: 4

Outside diff range and nitpick comments (1)
LEARN.md (1)

47-47: Consider simplifying the language for clarity.

The phrase "Individuals with expertise in" could be simplified to "Experts in" to make the sentence more concise and direct.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 75e0b62 and 5887186.
Files selected for processing (1)
  • LEARN.md (1 hunks)
Additional Context Used
LanguageTool (1)
LEARN.md (1)

Near line 47: ‘In’ is unnecessary in most cases before the expression ‘next .’.
Context: ...his project? Individuals with expertise in Next.js, TypeScript, Tailwind CSS, and Appwr...
Rule ID: CONFUSION_OF_NN_IN_NEXT_NNP

Markdownlint (21)
LEARN.md (21)

25: Expected: 2; Actual: 3
Unordered list indentation


29: Expected: 2; Actual: 3
Unordered list indentation


33: Expected: 2; Actual: 3
Unordered list indentation


37: Expected: 2; Actual: 3
Unordered list indentation


38: Expected: 0 or 2; Actual: 1
Trailing spaces


23: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


27: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


46: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


49: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


52: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


55: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


58: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


61: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


64: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


24: null
Lists should be surrounded by blank lines


28: null
Lists should be surrounded by blank lines


32: null
Lists should be surrounded by blank lines


36: null
Lists should be surrounded by blank lines

LEARN.md Outdated Show resolved Hide resolved
Meetjain1 and others added 2 commits May 25, 2024 23:33
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 4

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5887186 and 5921dd1.
Files selected for processing (1)
  • LEARN.md (1 hunks)
Additional Context Used
LanguageTool (1)
LEARN.md (1)

Near line 46: ‘In’ is unnecessary in most cases before the expression ‘next .’.
Context: ...his project? Individuals with expertise in Next.js, TypeScript, Tailwind CSS, and Appwr...
Rule ID: CONFUSION_OF_NN_IN_NEXT_NNP

Markdownlint (21)
LEARN.md (21)

25: Expected: 2; Actual: 3
Unordered list indentation


29: Expected: 2; Actual: 3
Unordered list indentation


33: Expected: 2; Actual: 3
Unordered list indentation


37: Expected: 2; Actual: 3
Unordered list indentation


23: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


27: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


42: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


45: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


48: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


51: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


54: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


57: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


60: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


63: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


24: null
Lists should be surrounded by blank lines


28: null
Lists should be surrounded by blank lines


32: null
Lists should be surrounded by blank lines


36: null
Lists should be surrounded by blank lines


37: null
Lists should be surrounded by blank lines

LEARN.md Outdated Show resolved Hide resolved
LEARN.md Show resolved Hide resolved
LEARN.md Show resolved Hide resolved
LEARN.md Show resolved Hide resolved
Meetjain1 and others added 2 commits May 25, 2024 23:35
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Meetjain1 Meetjain1 changed the title Create LEARN.md fix: Created LEARN.md May 25, 2024
@github-actions github-actions bot removed the title needs formatting Title of issue or pull request does not match the guidelines label May 25, 2024
@Meetjain1
Copy link
Contributor Author

@Sanchitbajaj02 have a look on this pr . Thankyou

Copy link
Owner

@Sanchitbajaj02 Sanchitbajaj02 left a comment

Choose a reason for hiding this comment

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

LGTM

@Sanchitbajaj02 Sanchitbajaj02 added 📄 docs update Improvements or additions to documentation EASY Difficulty Level: Easy level1 10 points gssoc GSSOC'24 Required Label and removed wait for reviewers labels May 26, 2024
@Sanchitbajaj02 Sanchitbajaj02 merged commit 116d947 into Sanchitbajaj02:master May 26, 2024
7 of 8 checks passed
@Meetjain1
Copy link
Contributor Author

@Sanchitbajaj02 gssoc label is wrong please change it .
currently "gsssoc" should be "gssoc"

@Sanchitbajaj02
Copy link
Owner

@Sanchitbajaj02 gssoc label is wrong please change it . currently "gsssoc" should be "gssoc"

Thanks, for informing. It is changed now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 docs update Improvements or additions to documentation EASY Difficulty Level: Easy gssoc GSSOC'24 Required Label level1 10 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing LEARN.md_Docs:
2 participants