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

General documentation enhancement #1651

Open
tishoyanchev opened this issue Dec 12, 2024 · 0 comments
Open

General documentation enhancement #1651

tishoyanchev opened this issue Dec 12, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement Adding a new feature or improving existing code

Comments

@tishoyanchev
Copy link
Contributor

tishoyanchev commented Dec 12, 2024

Detailed description of what you want to happen

Make an overarching and comprehensive documentation update of the entire DDS.
Key points:
1 - The usage of Tailwind-DDS. It needs to be explained more clearly step by step how to install and use the Tailwind project, how to build it, and more examples need to be provided. Some important questions to cover:
- when and why should a developer use Tailwind
- how to include their project in the Tailwind build process
- what else can they use from Tailwind (tailwind components etc.)
- what should they not use
- code examples
- documentation should be in one place (storybook)

2 - The usage and incorporation of DDS components into S sharp, Blazor and similar environments
- Since DDS components are custom html elements, they can be used with any technology that allows html templating or equivalent environment.

3 - Basic introduction and installation of the available packages and ways of using the code components
- The installation command for the package provided in the Angular section is for the standard components, and not Angular
- There are 4 sections - Angular, React, Vanilla CDN and Vue, but the section for standard components is missing.
- In Storybook, Getting started page, the introduction should be on how to install the standard package with access links for the wrapper component packages. Instead, in the page, it is explained how to install Angular with a package for standard components.

4 - The workflow and process of user contribution

5 - App-level guidelines

6 - CDN link
- make it more clear that users can use only the icons with our CDN link
- make it clear that version control is possible
7 - Available attributes on the table (width/resizable etc)

8 - Storybook FAQ
- Align with Sebastian

9 - Add Getting Started documentation. Document the 3 main use cases;
- Case 1 is when you have an existing app, perhaps with bootstrap or some library installed on it. What to do in that case? What is the correct approach in order to incorporate and integrate our DDS components.
- Case 2 is when you have a new app. This is already explained.
- Case 3 is when you are using a 3rd party platform like LifeRay. How to integrate our DDS components in it? This needs to be explained.

10 - Consider the idea of providing a code snippet with the proper use of the code components inside JS frameworks - Vue/React/Angular. It could be inside the Development page in Storybook.

11 - Update the README of the Icon Library
- Align with designers

Upload a screenshot or reference an example if possible

No response

Why do you need this feature?

Better UX

Do you have a deadline?

By June

Additional information

No response

@tishoyanchev tishoyanchev added enhancement Adding a new feature or improving existing code request User request documentation Improvements or additions to documentation and removed request User request labels Dec 12, 2024
@tishoyanchev tishoyanchev moved this from Low Priority to Mid Priority in Infineon Digital Design System - Public Board Dec 12, 2024
@tishoyanchev tishoyanchev self-assigned this Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Adding a new feature or improving existing code
Development

No branches or pull requests

1 participant