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

Create a Design System README.md and Banner File #415

Open
ashleyshaw opened this issue Oct 12, 2024 · 0 comments
Open

Create a Design System README.md and Banner File #415

ashleyshaw opened this issue Oct 12, 2024 · 0 comments
Assignees
Labels
Design System Issues related to the system of combining components according to best practices. [Status] Needs Design Needs design efforts.
Milestone

Comments

@ashleyshaw
Copy link
Member

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:

  1. Write a README.md for the design system.
    • Include an introduction, usage instructions, and any dependencies.
  2. Design a banner image that aligns with the design system's branding.
  3. Determine the best location for the README.md and banner file in the repository.
  4. 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 plugin README.md.

References:

  • Examples of how banners are used in other plugins' README.md files for guidance.
@ashleyshaw ashleyshaw added [Status] Needs Design Needs design efforts. [Status] Needs More Info Follow-up required in order to be actionable. labels Oct 12, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage in Tour Operator Oct 12, 2024
@ashleyshaw ashleyshaw added the Design System Issues related to the system of combining components according to best practices. label Oct 12, 2024
@ashleyshaw ashleyshaw added this to the 2.0.0 milestone Oct 13, 2024
@ZaredRogers ZaredRogers self-assigned this Oct 21, 2024
@ZaredRogers ZaredRogers removed the [Status] Needs More Info Follow-up required in order to be actionable. label Oct 21, 2024
@ZaredRogers ZaredRogers moved this from Needs Triage to Needs Design in Tour Operator Oct 21, 2024
@ashleyshaw ashleyshaw modified the milestones: 2.0.0, 2.1.0 Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design System Issues related to the system of combining components according to best practices. [Status] Needs Design Needs design efforts.
Projects
Status: Needs Design
Development

No branches or pull requests

2 participants