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: missing equal sign in doc #3479

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

TenzDelek
Copy link
Contributor

@TenzDelek TenzDelek commented Dec 16, 2024

Description
continue of #2904

Summary by CodeRabbit

  • Documentation
    • Improved clarity and correctness of the tutorial on generating code with the Glee framework.
    • Updated command syntax for creating a Glee project for better accuracy.
    • Enhanced the introduction and background context to better explain Glee's integration with AsyncAPI.
    • Minor adjustments made to wording for consistency throughout the tutorial.
    • Refined summary and next steps sections to encapsulate objectives and encourage further learning.

Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request involves updates to the generate-code.md documentation tutorial for the Glee framework. The changes primarily focus on improving the document's clarity, syntax, and instructional quality. Modifications include refining the introduction, expanding the background context, correcting command syntax, and making minor wording adjustments to enhance the overall readability and understanding of the tutorial.

Changes

File Change Summary
markdown/docs/tutorials/generate-code.md - Rephrased introduction for better flow
- Expanded background context about Glee and AsyncAPI
- Updated command syntax from --template tutorial to --template=tutorial
- Minor wording refinements for consistency

Poem

🐰 In the realm of code, a tutorial gleams,
Glee and AsyncAPI dance in tech dreams,
Syntax polished, words refined with care,
A rabbit's guide to learning, beyond compare!
Documentation sparkles, knowledge takes flight 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4ce32d8 and b915693.

📒 Files selected for processing (1)
  • markdown/docs/tutorials/generate-code.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • markdown/docs/tutorials/generate-code.md

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

netlify bot commented Dec 16, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b915693
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67604b7168a50700088a609b
😎 Deploy Preview https://deploy-preview-3479--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.59%. Comparing base (dc7d0d3) to head (b915693).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3479   +/-   ##
=======================================
  Coverage   86.59%   86.59%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          575      575           
  Misses         89       89           

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

@TenzDelek TenzDelek changed the title fix: missing equal sign in generate-code.md fix: missing equal sign in doc Dec 16, 2024
@sambhavgupta0705
Copy link
Member

@TenzDelek can you please add the issue here also

@sambhavgupta0705
Copy link
Member

@TenzDelek netlify preview is not available
Can you please check it once

@TenzDelek
Copy link
Contributor Author

@TenzDelek netlify preview is not available Can you please check it once

hmm, didnt quite get you there. doesn't it deploy automatically when we raise a pr back then? or do we have a command now for that cc @sambhavgupta0705

@sambhavgupta0705
Copy link
Member

image

It is failing in your PR

@TenzDelek
Copy link
Contributor Author

TenzDelek commented Dec 16, 2024

the netlify is pointing out to some issue with ruby
image
image

cc @sambhavgupta0705 any thought on this? kinda strange cause only the md value was changed

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 16, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 41
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3479--asyncapi-website.netlify.app/

@TenzDelek
Copy link
Contributor Author

@sambhavgupta0705 fixed, probably due to network issue it seems cause redeploying it does the job

@TenzDelek
Copy link
Contributor Author

@TenzDelek can you please add the issue here also

i dont think there is any issue created for this as per the pr made by the last contributor

@sambhavgupta0705
Copy link
Member

@BhaswatiRoy @TRohit20 can you please review this PR

Copy link
Collaborator

@TRohit20 TRohit20 left a comment

Choose a reason for hiding this comment

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

Thanks for identifying and fixing the typo in the command! @TenzDelek

LGTM! @sambhavgupta0705

@TenzDelek
Copy link
Contributor Author

Thanks for identifying and fixing the typo in the command! @TenzDelek

LGTM! @sambhavgupta0705

it was identify by the previous contributor (#2904) , so all credit goes to her.

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.

4 participants