-
Notifications
You must be signed in to change notification settings - Fork 480
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
feat: rebranding docs #1856
feat: rebranding docs #1856
Conversation
tblivet
commented
Aug 7, 2024
Questions | Answers |
---|---|
Branch? | 9.x |
Description? | Docs for BO rebranding |
Fixed ticket? |
feat: rebranding WIP
Hello @tblivet @jolelievre Part of this content looks like it should be shared on the Build Blog, and another part looks like something we should put in "Notable changes" in the documentation, some is a generic information about CSS variables and something that could be part of the PrestaShop UI Kit repo only. I see three items: FirstFiles:
are good material for an article on the build blog or to the "second" point on this list. SecondFiles:
are good content for https://devdocs.prestashop-project.org/8/development/uikit/ ThirdFiles:
Something that should go to the Notable Changes. Let me know what you think. I'm not insisting on having an article on the build blog, but "Why" and "How we did it" should be inside UI Kit section and linked from the Notable changes :) |
development/rebranding/_index.md
Outdated
title: Back office rebranding | ||
weight: 60 | ||
chapter: true | ||
useMermaid: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need to load mermaid if you don't use mermaid 😎
Hi @kpodemski and @jolelievre, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's the review. I added some suggestions.
@@ -0,0 +1,27 @@ | |||
--- | |||
title: BO rebranding |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can put this content inside the Notable Changes page that already exists:
https://devdocs.prestashop-project.org/9/modules/core-updates/9.0/
You can create a new section, "Back office rebranding", at the end of this page.
@@ -0,0 +1,20 @@ | |||
--- | |||
title: BO breaking changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This content should be part of the existing notable changes page.
development/core-updates/_index.md
Outdated
@@ -0,0 +1,12 @@ | |||
--- | |||
title: Core changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not needed page.
@@ -1,6 +1,6 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need to leave this page and create an alias, so that the old page will point to the new page.
development/ui-kit/css-variables.md
Outdated
weight: 64 | ||
--- | ||
|
||
# Introducing CSS variables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Introducing CSS variables | |
# CSS variables in PrestaShop UI Kit |
development/ui-kit/how-to-use-it.md
Outdated
@@ -0,0 +1,55 @@ | |||
--- | |||
title: How to use it ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: How to use it ? | |
title: How to use it? |
development/ui-kit/how-to-use-it.md
Outdated
|
||
# How to use new set of CSS variables ? | ||
|
||
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop. | |
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use them. |
development/ui-kit/how-to-use-it.md
Outdated
|
||
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop. | ||
|
||
## Using CSS variables with v9 and higher |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Using CSS variables with v9 and higher | |
## Using CSS variables in PrestaShop 9.0+ |
development/ui-kit/how-to-use-it.md
Outdated
|
||
## Using CSS variables with v9 and higher | ||
|
||
In PrestaShop v9 and higher, use the CSS variables introduced in `_root.scss` for consistent styling in the Back Office. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In PrestaShop v9 and higher, use the CSS variables introduced in `_root.scss` for consistent styling in the Back Office. | |
In PrestaShop v9 and later, we use the CSS variables introduced in `_root.scss` for consistent styling in the back office. |
development/ui-kit/how-to-use-it.md
Outdated
**Note:** | ||
|
||
- `--cdk-primary-800` is a CSS variable defined in `_root.scss`. It ensures consistent color application across the back office. | ||
- Refer to `_root.scss` for the latest <a href="https://github.com/PrestaShop/prestashop-ui-kit/blob/develop/scss/_root.scss" target="_blank">list of available variables</a>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here I think you should use refrel
to the docs page you created, right?
Hi @kpodemski, I have just added your suggestions. Is it okay for you? |
love it, thank you @tblivet ! |
Thank you @tblivet 😄 |