-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Description
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)

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 follow the new Sistent MDX documentation structure. This requires creating a new folder at src/collections/sistent/components/card/ with three distinct files:
index.mdx: Explanation of the function that the component serves in context of its usage (Overview). This should also include usage and information for accompanying utility components:CardActionsCardContentCardHeaderCardMedia
guidance.mdx: Stylistic guidelines and best practices to be followed while using the component in code.code.mdx: Code examples showing various usages using<ThemeWrapper>and<CodeBlock>.
Additionally, the component needs to be added to the Sistent side navigation by creating entries for all three tabs in src/components/SistentNavigation/content.js.
Contributor Resources and Handbook
The layer5.io website uses Gatsby, React, and GitHub Pages. Site content is found under the master branch.
- 🎨 See Sistent Repository.
- 📚 See contributing instructions.
- 🎨 Wireframes and designs for Layer5 site in Figma (open invite)
- 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack.
Join the Layer5 Community by submitting your community member form.