-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
Design SystemIssues related to the system of combining components according to best practices.Issues related to the system of combining components according to best practices.[Status] Needs DesignNeeds design efforts.Needs design efforts.no-issue-activity
Milestone
Description
Description:
We need to create a README.md
for the design system to provide clear documentation and usage guidelines. Additionally, a banner file needs to be created that might be used in the plugin's README.md
. Let's discuss where these files should be placed and how the banner can be incorporated into the plugin documentation.
Tasks:
- Write a
README.md
for the design system.- Include an introduction, usage instructions, and any dependencies.
- Design a banner image that aligns with the design system's branding.
- Determine the best location for the
README.md
and banner file in the repository. - Confirm if and how the banner should be integrated into the plugin's
README.md
.
Considerations:
- The
README.md
should be placed in the root of the design system directory or wherever the design system's main files are stored. - The banner file might need to be placed in an
assets
folder, which is commonly used for storing images for the pluginREADME.md
.
References:
- Examples of how banners are used in other plugins'
README.md
files for guidance.
Metadata
Metadata
Assignees
Labels
Design SystemIssues related to the system of combining components according to best practices.Issues related to the system of combining components according to best practices.[Status] Needs DesignNeeds design efforts.Needs design efforts.no-issue-activity
Type
Projects
Status
Needs Design