Skip to content

Add Screenshots for Component Introductions in Documentation #2255

@zhouByte-hub

Description

@zhouByte-hub

Hello, I am a user of this project. During use, I found that the current project documentation only includes text descriptions and usage methods for each component, but lacks corresponding screenshots to show their actual effect.
For new users, it is difficult to quickly understand the actual presentation effect, style, and usage scenarios of the components only through text descriptions. They need to spend a lot of time deploying and running the code to see the full picture of the components, which to a certain extent reduces the readability and user experience of the documentation.

Therefore, I hope to add corresponding screenshots (either screenshots or sample renderings) for the introduction of each component in the documentation, helping users quickly and intuitively understand the appearance and usage effect of the components.

Specific Suggestions

  1. Add a screenshot of the component below the text introduction of each component. It is recommended to clearly show the complete appearance of the component and its core interaction states (such as default state, active state, etc.).

  2. It is recommended that the screenshots maintain a uniform size and style to ensure the overall beauty and tidiness of the documentation.

  3. If a component has multiple usage scenarios or style variants, corresponding screenshots can be added separately, with clear scene descriptions marked.

Expected Effect

Users can quickly and intuitively understand the actual presentation effect of each component through the documentation without additional code deployment, improving the practicality and usability of the documentation and reducing the learning cost for new users.

Thank you for the hard work of the team, and look forward to the optimization of this feature!

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