layer5 icon indicating copy to clipboard operation
layer5 copied to clipboard

[Sistent] Add Card component to the sistent components page

Open dragon-slayer875 opened this issue 1 year ago β€’ 1 comments

Current Behavior

Layer5 and it's projects use Sistent library to enable easy component reusability among our various projects. One such component is Card.

(https://playground.meshery.io/user/preferences) image

Ideally, all sistent components are represented on https://layer5.io/projects/sistent/components, so a centralized usage and example documentation can be maintained. This will aid new developers to more quickly jump into contributing to the various projects. The Card component currently needs this representation.

Desired Behavior

Proper documentation for Card component similar to Button component on https://layer5.io/projects/sistent/components The documentation should include:

  • Explanation of the the function that the component serves in context of it's usage.
  • Usage and information of accompanying utility components:
    • CardActions
    • CardContent
    • CardHeader
    • CardMedia
  • Code examples.
  • Stylistic guidelines to be followed while using the component in code (if any).

Contributor Resources and Handbook

The layer5.io website uses Gatsby, React, and GitHub Pages. Site content is found under the master branch.

Join the Layer5 Community by submitting your community member form.

dragon-slayer875 avatar Sep 23 '24 02:09 dragon-slayer875

I can work on this! πŸ™‹

Anand-Theertha avatar Oct 21 '24 13:10 Anand-Theertha

Quick question: Where can I find the content that describes about the component and its utility components? @dragon-slayer875 @leecalcote

Anand-Theertha avatar Oct 24 '24 17:10 Anand-Theertha

@nebula-aac @sudhanshutech @SAHU-01 @NishantSinghhhhh can assist.

leecalcote avatar Oct 24 '24 17:10 leecalcote

Yes sir I am ready to work on this component

NishantSinghhhhh avatar Oct 24 '24 17:10 NishantSinghhhhh

Hey @NishantSinghhhhh, I am currently working on this task. I just wanted some clarification on what information I need to put to describe the Card component.

Anand-Theertha avatar Oct 25 '24 06:10 Anand-Theertha

Hey @NishantSinghhhhh, I am currently working on this task. I just wanted some clarification on what information I need to put to describe the Card component.

See when you go on the components page of sistent project, there are lot many components listed in there like button, modal etc , just click on the component and then you will see how it each component is described.

You have to write about the types of cards their use cases , and explain the utility functions that are attached with the card , along with this provided some guidance to the developers as in where to use card and what UI-UX themes are required in the guidance tab and then in code.js you have to present the code for all the components that you have rendered

NishantSinghhhhh avatar Oct 25 '24 07:10 NishantSinghhhhh

Awesome, got it.

Anand-Theertha avatar Oct 25 '24 07:10 Anand-Theertha

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Apr 26 '25 02:04 stale[bot]

This issue is being automatically closed due to inactivity. However, you may choose to reopen this issue.

stale[bot] avatar Apr 27 '25 11:04 stale[bot]