-
-
Notifications
You must be signed in to change notification settings - Fork 1
Create a Design System README.md and Banner File #415
Copy link
Copy link
Open
Labels
area:design-systemTokens/components guidelinesTokens/components guidelinesstatus:needs-designEarly execution signal (triage queue for design)Early execution signal (triage queue for design)status:needs-devEarly execution signal (triage queue for engineering)Early execution signal (triage queue for engineering)
Milestone
Metadata
Metadata
Assignees
Labels
area:design-systemTokens/components guidelinesTokens/components guidelinesstatus:needs-designEarly execution signal (triage queue for design)Early execution signal (triage queue for design)status:needs-devEarly execution signal (triage queue for engineering)Early execution signal (triage queue for engineering)
Type
Fields
Give feedbackPriority
None yet
Projects
StatusShow more project fields
📥 Needs Dev
Description:
We need to create a
README.mdfor 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'sREADME.md. Let's discuss where these files should be placed and how the banner can be incorporated into the plugin documentation.Tasks:
README.mdfor the design system.README.mdand banner file in the repository.README.md.Considerations:
README.mdshould be placed in the root of the design system directory or wherever the design system's main files are stored.assetsfolder, which is commonly used for storing images for the pluginREADME.md.References:
README.mdfiles for guidance.