-
Notifications
You must be signed in to change notification settings - Fork 0
proper readme #14
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
base: main
Are you sure you want to change the base?
proper readme #14
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive README file for the ui-library project, transforming a basic installation guide into complete documentation. The README now includes detailed setup instructions, usage examples, development guidelines, and contribution information.
Key Changes:
- Expanded installation instructions to include required dependencies (tailwindcss, postcss)
- Added configuration guidance, development setup, and storybook viewing instructions
- Included project structure overview and contribution guidelines
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| export default () => ( | ||
| <> | ||
| <Button variant="ghost">A spooky disabled button</Button> |
Copilot
AI
Oct 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The button text says 'disabled' but no disabled prop is set. This could confuse users following the example. Either add the disabled prop or update the button text to accurately reflect its state.
| <Button variant="ghost">A spooky disabled button</Button> | |
| <Button variant="ghost" disabled>A spooky disabled button</Button> |
| export default () => ( | ||
| <> | ||
| <Button variant="ghost">A spooky disabled button</Button> | ||
| <SwitchWithDescription | ||
| description="This is a switch description." | ||
| id="first" | ||
| label="Switch Text" | ||
| /> | ||
| </> |
Copilot
AI
Oct 16, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Anonymous default export in example code. Consider using a named function export for better debugging and code clarity in documentation examples.
| export default () => ( | |
| <> | |
| <Button variant="ghost">A spooky disabled button</Button> | |
| <SwitchWithDescription | |
| description="This is a switch description." | |
| id="first" | |
| label="Switch Text" | |
| /> | |
| </> | |
| export default function ExampleComponent() { | |
| return ( | |
| <> | |
| <Button variant="ghost">A spooky disabled button</Button> | |
| <SwitchWithDescription | |
| description="This is a switch description." | |
| id="first" | |
| label="Switch Text" | |
| /> | |
| </> | |
| ); | |
| } |
adds a proper readme file