docs(design-system): add tailwind migration docs #1221
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JammingBen
force-pushed
the
docs/tailwind-ods-docs
branch
2 times, most recently
from
08c236f to
ac69a9b
Compare
JammingBen
commented
Sep 19, 2025
|
|
||
| ## Helper methods | ||
|
|
||
| The design-system provides a set of helper methods and composables that might be helpful, especially when developing apps or extensions within the OpenCloud ecosystem. |
Contributor
Author
There was a problem hiding this comment.
Ideally here should be a link to the docs for the helper methods, unfortunately they don't exist yet.
JammingBen
force-pushed
the
docs/tailwind-ods-docs
branch
from
ac69a9b to
5d1112c
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for migrating to Tailwind CSS in the design-system v4 and restructures the documentation organization. The main purpose is to help developers transition from the old custom utility classes to Tailwind's standardized approach.
- Adds a detailed Tailwind migration guide with mapping tables for utility classes, components, and custom CSS
- Restructures documentation by moving installation/usage guides from README to dedicated docs files
- Adds documentation for the new OcCard component
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/design-system/src/components/OcCard/OcCard.vue | Minor comment formatting fix removing HTML tags |
| packages/design-system/docs/gettingStarted/usage.md | New usage guide explaining components, utility classes, and helper methods |
| packages/design-system/docs/gettingStarted/tailwindMigration.md | Comprehensive migration guide with utility class mappings and component changes |
| packages/design-system/docs/gettingStarted/installation.md | New installation guide moved from README with setup instructions |
| packages/design-system/docs/designTokens/colorRoles.md | Updates styling and adds Tailwind utility class usage examples |
| packages/design-system/docs/designTokens/colorPalette.md | Removes redundant styling |
| packages/design-system/docs/components/OcCard/OcCard.md | New component documentation for OcCard |
| packages/design-system/docs/.vitepress/theme/custom.scss | Adds styling for documentation tables and live code blocks |
| packages/design-system/docs/.vitepress/config.ts | Updates navigation to include new getting started section |
| packages/design-system/README.md | Simplifies README by moving detailed content to dedicated docs |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
packages/design-system/docs/gettingStarted/tailwindMigration.md
Outdated
Show resolved
Hide resolved
JammingBen
force-pushed
the
docs/tailwind-ods-docs
branch
from
5d1112c to
ab3f795
Compare
Co-authored-by: Benedikt Kulmann <b.kulmann@opencloud.eu>
openclouders
pushed a commit
that referenced
this pull request
Sep 22, 2025
docs(design-system): add tailwind migration docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds tailwind migration docs and restructures the design-system docs in general. The guide on how to install and initialize it has been moved from the readme file to the docs.
Also adds docs for the new
OcCardcomponent.closes #937