Skip to content

Feature Request: Enhance Documentation for Design Tokens Usage #2251

@mowslasher83

Description

@mowslasher83

Summary

The current documentation for the plasma-tokens, plasma-tokens-web, and plasma-tokens-b2c packages contains a brief mention of design tokens and links to further resources. However, it would be beneficial to provide a more comprehensive guide that demonstrates practical examples of how to effectively use these design tokens in applications.

Proposed Improvements

  1. Example Scenarios: Include a few real-world scenarios where design tokens can be applied, such as text styling, theme customization, and responsive design.
  2. Code Snippets: Provide code snippets or examples in both CSS and JavaScript that showcase how to implement these tokens effectively.
  3. Best Practices: Outline best practices for using design tokens within projects, such as naming conventions, organization, and maintaining consistency.
  4. Visual Guides: Consider adding visual guides or diagrams that illustrate how different tokens can interplay in a design system.

Benefits

Enhancing the documentation in this manner would improve the onboarding experience for new developers and help existing users utilize the design tokens more efficiently, potentially increasing the overall adoption of the Plasma design system.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions