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.

Sign up for GitHub

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

Jump to bottom

Improve Usage Documentation show README examples of each component #95

Merged
merged 3 commits into from
Dec 4, 2024
Merged

Improve Usage Documentation show README examples of each component #95

merged 3 commits into from
Dec 4, 2024

Conversation

AnasSarkiz
Copy link
Member

@AnasSarkiz AnasSarkiz commented Nov 29, 2024 •
edited
Loading

/closes #88
/closes #94
Screenshot 2024-11-29 at 9 38 14 PM

@AnasSarkiz AnasSarkiz requested a review from seveibar November 29, 2024 19:41
seveibar
seveibar requested changes Nov 30, 2024
View reviewed changes
Copy link
Contributor

@seveibar seveibar left a comment

Choose a reason for hiding this comment

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

  • Each component should have it's props in a table under it
  • Don't have a separate component props reference
  • Table of contents at top
  • We should include an image of the example circuit ideally

@AnasSarkiz AnasSarkiz requested a review from seveibar December 2, 2024 18:36
@AnasSarkiz
Copy link
Member Author

@seveibar, take a look at the latest changes

@AnasSarkiz AnasSarkiz merged commit dd2eaef into tscircuit:main Dec 4, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seveibar seveibar seveibar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@AnasSarkiz @seveibar