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

feat: migrate asyncapi3comparison and tabs #2769

Merged

Conversation

vishvamsinh28
Copy link
Contributor

migrated asyncapi3comparison and tabs

Copy link

netlify bot commented Mar 13, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 165bd81
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6603b7b27b33ed0008680df0
😎 Deploy Preview https://deploy-preview-2769--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.


/**
* @description Component for comparing AsyncAPI versions based on ID and address.
* @param {AsyncAPI3IdAndAddressComparisonProps} props - Props for the component.
Copy link
Member

Choose a reason for hiding this comment

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

create separate params like props.className inside jsDoc comments.

Copy link
Member

Choose a reason for hiding this comment

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

define these types in the component file itself, since these types are specific to those components only.

@vishvamsinh28
Copy link
Contributor Author

@akshatnema @anshgoyalevil updated the pr

Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

Apply these changes in all the files.

</div>
<div className='ml-1 flex-1 border border-black p-2'>
<h3 className='mb-4 ml-2 font-sans text-lg font-medium'>AsyncAPI 3.0</h3>

Copy link
Member

Choose a reason for hiding this comment

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

@vishvamsinh28 Kindly avoid these unnecessary blank lines.

</div>
</div>
</div>
</div >
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
</div >
</div>

Specify this closing div tag properly

@vishvamsinh28
Copy link
Contributor Author

@akshatnema updated the pr and removed unnecessary line breaks

Copy link
Member

Choose a reason for hiding this comment

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

Include these types in the Tabs component itself.


/**
* @description Tabs component to display a set of tabs with associated content.
* @param {TabsProps} props - The props for the Tabs component.
Copy link
Member

Choose a reason for hiding this comment

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

Explain each object inside the props in the jsDoc.

Comment on lines 8 to 9
* @param {string} [props.className=''] - Additional CSS classes for styling.
* @description React component for comparing AsyncAPI schema formats between versions 2.x and 3.0.
Copy link
Member

Choose a reason for hiding this comment

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

provide @description above @param.

@vishvamsinh28
Copy link
Contributor Author

@akshatnema pr updated

@akshatnema
Copy link
Member

@vishvamsinh28 resolve the lint errors.

@vishvamsinh28
Copy link
Contributor Author

@akshatnema lint error fixed

@akshatnema
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 39a73bb into asyncapi:migrate-ts Mar 27, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants