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[DOCS] : add useScaffoldStarkProfile documentation #89

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Oladayo-Ahmod
Copy link

@Oladayo-Ahmod Oladayo-Ahmod commented Jan 14, 2025

Add Documentation for useScaffoldStarkProfile

Fixes #83

Types of change

  • Bug
  • Enhancement

Comments (optional)

This PR adds detailed documentation for the useScaffoldStarkProfile hook, including usage example, configuration, return values, and best practices. It aims to help developers integrate Stark profiles more efficiently.

@Oladayo-Ahmod Oladayo-Ahmod changed the title Addition[DOCS] : add useScaffoldStarkProfile documentation feat[DOCS] : add useScaffoldStarkProfile documentation Jan 14, 2025
Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

Thank you for the nice documentation

Comment on lines +42 to +43
This example demonstrates how to use the `useScaffoldStarkProfile` hook to display a user's StarkNet profile with their name and profile picture.

Copy link
Collaborator

Choose a reason for hiding this comment

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

you can move this to below "Usage Example" before the code snippet.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the comment. I have fixed this.

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.

Documentation on useScaffoldStarkProfile
2 participants