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

Edited the .md File to include steps forgotton to be shown in the gif. #206

Merged
merged 1 commit into from
Dec 14, 2024

Conversation

Cheezik
Copy link
Contributor

@Cheezik Cheezik commented Dec 14, 2024

As mentioned in the title. It seems like i forgot to add the part where i show what boxes should be checked while generating the token used.

Summary by CodeRabbit

  • Documentation
    • Added a section detailing required permissions for generating a personal access token.
    • Enhanced clarity with bold text for critical instructions.
    • Minor formatting adjustments to improve readability.

Copy link

coderabbitai bot commented Dec 14, 2024

Walkthrough

The changes in the tutorial document focus on enhancing the section related to generating a personal access token. A new section detailing the necessary permissions for the token has been added, specifying which boxes to check for repository access and user information. Minor formatting adjustments were made, including the use of bold text for critical instructions and the removal of commented-out code. The overall structure of the tutorial remains unchanged, and no new functionality or workflow alterations were introduced.

Changes

File Change Summary
wiki/Tutorial.md Added a section on required permissions for generating a personal access token; formatted text for clarity; removed commented-out code listing permissions.

Poem

In the garden of code, where rabbits play,
A token's permissions now light the way.
With bolded instructions, so clear and bright,
We hop through the steps, all feeling just right!
Let's celebrate changes, both small and grand,
In the world of GitHub, together we stand! 🐇✨


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. (Experiment)
  • @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.

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

🧹 Outside diff range and nitpick comments (1)
wiki/Tutorial.md (1)

33-42: Add language specification to the code block.

To improve formatting and satisfy markdown linting rules, specify the language for the fenced code block.

-```
+```markdown
 Repo
  -  repo:status
  -  repo_deployment
  -  public_repo
🧰 Tools
🪛 Markdownlint (0.37.0)

33-33: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 88bc12b and fbf1be2.

📒 Files selected for processing (1)
  • wiki/Tutorial.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
wiki/Tutorial.md

33-33: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (1)
wiki/Tutorial.md (1)

31-42: LGTM! Valuable addition to the documentation.

This is an excellent addition that clearly specifies the required token permissions, making the documentation more complete and user-friendly. The content perfectly addresses the gap mentioned in the PR objectives by detailing the permissions that weren't visible in the GIF.

🧰 Tools
🪛 Markdownlint (0.37.0)

33-33: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@vn7n24fzkq
Copy link
Owner

Thanks!!

@vn7n24fzkq vn7n24fzkq merged commit 1f8ff37 into vn7n24fzkq:main Dec 14, 2024
3 checks passed
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