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

Fixing options documentation organization in readme #2236

Open
mezzode opened this issue Oct 29, 2022 · 1 comment · May be fixed by #2242
Open

Fixing options documentation organization in readme #2236

mezzode opened this issue Oct 29, 2022 · 1 comment · May be fixed by #2242
Assignees
Labels
enhancement New feature or request.

Comments

@mezzode
Copy link

mezzode commented Oct 29, 2022

Is your feature request related to a problem? Please describe.

The readme has the options documentation for all the cards under the Stats Card section which is a little confusing

Describe the solution you'd like

The options docs should be moved to be under the headers for each appropriate card section. Additionally since there's some duplication between the docs and the usage examples, perhaps the examples for each card could be made collapsible to make the readme more easily readable

Describe alternatives you've considered

No response

Additional context

I'm interested in making a PR for this for Hacktoberfest

@mezzode mezzode added the enhancement New feature or request. label Oct 29, 2022
@rickstaa
Copy link
Collaborator

@mezzode first of all great that you want to contribute! 🚀 I agree that the documentation is a bit cluttered. I like your suggestions. Feel free to create a pull request to improve the documentation, and I will review it as a Hacktoberfest item. 👍🏻

@mezzode mezzode linked a pull request Oct 29, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants