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.

Sign up for GitHub

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

docs: clarifying DSP backwards compatibility #1439

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −4
Open

docs: clarifying DSP backwards compatibility #1439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/material-dsp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ It is possible to configure the import process. The _UnoDspImportColors_ item fo

## More flexibility

This will generate the file at each build, potentially overriding any changes you made to the file. If you want to keep it that way, you can simply remove the `ColorPaletteOverride.json` file from the `Styles` folder, the file won't get overwritten anymore.
This will generate the `ColorPaletteOverride.xaml` file at each build, potentially overriding any changes you made to it. If you want to prevent it from being overriden, you can simply remove the `ColorPaletteOverride.json` file from the `Styles` folder.

Alternatively, you can also use the [Uno.Dsp.Cli](https://nuget.org/packages/Uno.Dsp.Cli) package to generate the file from the command line. This will allow you to generate the file only when you want to, and not at each build.
Alternatively, you can also use the [Uno.Dsp.Cli](https://nuget.org/packages/Uno.Dsp.Cli) package to generate the file from the command line.

> [!NOTE]
> Although the **Material Theme Builder Tool** doesn't export **Material Tokens (DSP)** packages anymore, to import DSP packages just follow the same steps described previously and save the downloaded DSP zip file as `ColorPaletteOverride.zip` in the `Styles` folder of your application project.
> In that case, make sure to delete the `material-theme.json` file from `Styles` folder before building your application, to avoid conflicts.
> Although the **Material Theme Builder Tool** doesn't export **Material Tokens (DSP)** .zip packages anymore, Uno.Dsp.Tasks still supports them for backwards compatibility. To use a DSP .zip package just save it as `ColorPaletteOverride.zip` in the `Styles` folder of your application project.
> Make sure to delete the `material-theme.json` file from `Styles` folder before building your application, to avoid conflicts.
Comment on lines +73 to +74
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussion with @agneszitte:

"I think we should add a section to the same page on Uno.Themes
Where we detail what to do in a scenario where we have an old Uno project and want to use Material Theme Builder with the .json file
But I think we have to wait till we know if singleproject is required to add a section like that"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi @carldebilly we would need to sync back on this doc update when you are back so we can close the PR with the appropriate last changes please

Loading