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

docs : Update component instructions in next readme. #11

Merged
merged 8 commits into from
Jan 30, 2025

Conversation

Ta5r
Copy link
Contributor

@Ta5r Ta5r commented Jan 29, 2025

What

  • This PR updates components instructions in packages/next Readme docs.

Why

  • This PR enhances documentation by providing more information on the component props for better DX for components present in our next package ( The <Parse>, <Image>, <Link> and <Script> components)

Related Issue(s):

How

Checklist

  • I have read the Contribution Guidelines.
  • My code is tested to the best of my abilities.
  • My code passes all lints (ESLint, tsc, prettier etc.).
  • My code has detailed inline documentation.
  • I have added unit tests to verify the code works as intended.
  • I have updated the project documentation accordingly.

@Ta5r Ta5r marked this pull request as ready for review January 29, 2025 12:34
@Ta5r Ta5r requested a review from justlevine January 29, 2025 12:34
ayushnirwal
ayushnirwal previously approved these changes Jan 30, 2025
Copy link
Collaborator

@ayushnirwal ayushnirwal left a comment

Choose a reason for hiding this comment

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

Almost done. This can be merged after a few minor changes

packages/next/README.md Outdated Show resolved Hide resolved
packages/next/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@justlevine justlevine left a comment

Choose a reason for hiding this comment

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

Fixed the hierarchy. Will backfill the missing exports in a followup PR.

@justlevine justlevine merged commit 214d614 into develop Jan 30, 2025
8 checks passed
@justlevine justlevine deleted the docs/next-pckg branch January 30, 2025 13:56
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.

3 participants