瀏覽代碼

docs: update faq

pointhalo 3 年之前
父節點
當前提交
0c8c4ba9d6
共有 3 個文件被更改,包括 25 次插入16 次删除
  1. 4 0
      content/start/changelog/index.md
  2. 12 8
      content/start/faq/index-en-US.md
  3. 9 8
      content/start/faq/index.md

+ 4 - 0
content/start/changelog/index.md

@@ -369,6 +369,10 @@ Semi 版本号遵循**Semver**规范(主版本号-次版本号-修订版本号
   - 其他调整
     - 由于 Icon 方案的调整,Icon、Empty 组件使用 icon、插画的方式与之前不同,具体请看 [1.x 迁移 2.x 指南](/zh-CN/start/update-to-v2)
 
+#### 🎉 1.33.1 - 1.38.x
+- 【docs】
+  - 字节跳动用户,若需要查询该区间段的 changelog 变更,请通过内网域名访问,在右上角 Header中切换至 1.x 文档站点查阅。该部分变更与 v2.0 - 2.4 重合,因此不在此处再次列举
+
 #### 🎉 1.33.0 (2021-10-22)
 - 【Fix】
     - 修复 Cascader组件同时使用 changeOnSelect 和 loadData 属性时,未选到最后一级的情况下,重置value无效 

+ 12 - 8
content/start/faq/index-en-US.md

@@ -10,15 +10,23 @@ order: 8
 
 
 #### What is the relationship between Semi 2.x (open source version) and Semi 1.x?
- - The Semi v2.0 version is refactored based on v1.x using ts, which brings a better ts experience and a more out-of-the-box engineering solution, which solves the coexistence of multi-component libraries in the micro front-end scenario Style conflict issues, etc. All subsequent long-term work of the Semi team will be based on the v2.x version
- - At present, v2.0 and v1.x will still be maintained in parallel for a period of time. Feature addition on v1.x will be gradually stopped in the future, and only necessary bug fix changes will be provided.
+ - The Semi v2.0 version is refactored based on v1.x using ts, which brings a better ts experience, bettter a11y support and a more out-of-the-box engineering solution, which solves the coexistence of multi-component libraries in the micro front-end scenario Style conflict issues, etc. All subsequent long-term work of the Semi team will be based on the v2.x version
+ - v1.x has stopped iterative maintenance, no more feature additions or complex changes, only necessary bug fix changes are provided.
  - For new projects, we recommend that you directly use 2.x [@douyin/semi-ui](https://semi.design) for development. For existing projects, we also recommend that you upgrade as soon as possible. In order to reduce the cost of upgrading, we provide a cli tool one-click migration (@ies/semi-codemod-v2) that can help you automatically complete up to 90% of the migration and modification (limited by the AST implementation principle, there are still a small number of cases that require manual labor review modification, but not much 😉)
  - Upgrade from Semi 1.x to Semi 2.x for detailed operation steps [From v1 to v2](https://semi.design/zh-CN/start/update-to-v2)
 
 #### Relationship between versions
 
-- The Semi version number follows the Semver specification (major version number-minor version number-revision number). We will add features or components to the minor version. In the patch version, we will only fix bugs and not update new features.
-- Between 2.x versions (that is, when the major version number is the same), the API will remain **forward compatible**, but there may be style adjustments between different minor versions. When you need to upgrade, we recommend you Use the version Diff function on the changelog page to check all changes and whether they really affect your business system.
+- Semi version numbers follow the Semver specification (major version number - minor version number - revision number). We will add features or components in the minor version, and we will only fix bugs in the patch version, but will not update new features. However, there may be style adjustments between different minor versions. When you need to upgrade, we recommend that you use the version diff on the changelog page to check all changes and whether they have an impact on your code.
+- All subsequent new features and components will be developed based on version 2.x. We recommend business parties to keep using the latest version as much as possible
+- Between 2.x versions, the API will remain **forward compatible**
+- The API will also remain **forward compatible** between 1.x versions. When upgrading from 1.x to 2.x, breaking changes will be included, please refer to the documentation for specific upgrade precautions
+- 0.x versions are currently discontinued, and hotfix updates are made if and only if a bugfix has to be done. When upgrading from 0.x to 1.x, breaking changes will be included. For specific upgrade precautions, please refer to the documentation
+
+#### Semi's default theme style does not match the positioning of our system. Can i configure another theme?
+
+- Please refer to [Custom theme](/en-US/start/customize-theme). Semi provides **up to 2300+ Design Tokens to allow users to perform in-depth customization**, whether you are a R&D or a designer, you can easily configure the style layer in [Semi DSM](/dsm), and in code, Figma always keep two-way sync. Based on Semi, you can **customize your own Design System at low cost** 
+- And when using, you only need to specify the theme package name used in webpack.config.js to complete the access (the Semi plugin needs to be connected).
 
 #### Why is defaultValue, default XXX not working?
 
@@ -40,10 +48,6 @@ Welcome to ours [Customer Service Lark Group](https://bytedance.feishu.cn/docs/d
 
 Our style is based on Scss, and we also use CSS Variable as the color wheel variable. Color variables and common variables are mounted under `body`. CSS Module is not used because we want to have a fixed className and retain the ability to modify / override Semi style for our users(although it is not recommended, it is really needed sometime).
 
-#### Semi's default theme style does not match the positioning of our system. Can i configure another theme?
-
-Please refer to [Custom theme](/en-US/start/customize-theme) . In [Semi DSM](/dsm) You can configure the style. You only need to specify the theme package name in `webpack.config.js` to complete the access.
-
 #### Why Tooltip、Typography does not set style word-break to all or word?  
    Content in difference languages (e.g. English, Chinese, combination of English and Chinese) may require different styles in terms of word-break, so Semi does not use a default setting. You could use corresponding CSS styles to your own needs.
 

+ 9 - 8
content/start/faq/index.md

@@ -8,19 +8,24 @@ order: 8
 
 #### Semi 2.x 与 Semi 1.x 有什么不同?
 
--   Semi v2.0 版本 基于 v1.x 使用 ts 进行了重构,带来了更好的 ts 使用体验、以及更开箱即用的工程化方案,解决了对微前端场景下多组件库共存的样式冲突问题等。Semi 2.x 为开源版本, Semi 团队后续所有长期工作都将基于 v2.x 版本进行
--   目前 v2.0 与 v1.x 仍将并行迭代维护一段时间,后续会逐步停止 v1.x 上的 feature 添加,仅提供必要的 bug fix 变更。
+-   Semi v2.0 版本 基于 v1.x 使用 ts 进行了重构,带来了更好的 ts 使用体验、以及更开箱即用的工程化方案,更好的a11y支持,支持局部启用暗色/亮色模式,解决了对微前端场景下多组件库共存的样式冲突问题等。Semi 2.x 为开源版本, Semi 团队后续所有长期工作都将基于 v2.x 版本进行
+-   v1.x 已停止迭代维护,不再进行feature添加或复杂变更,仅提供必要的 bug fix 变更。
 -   我们建议大家直接使用 2.x [@douyin/semi-ui](https://semi.design) 进行开发。现有旧项目,我们也建议大家尽快进行升级。为减轻升级成本,我们提供了 cli 工具一键迁移(@ies/semi-codemod-v2 )可帮助大家自动完成高达 90%的迁移修改(受限于 AST 实现原理,仍存在一小部分 case 需人工 review 修改,但不多 😉 )
 -   Semi 1.x 升级至 Semi 2.x 详细操作步骤请查阅 [从 v1 到 v2](https://semi.design/zh-CN/start/update-to-v2)
 
 #### 各版本之间的关系
 
--   Semi 版本号遵循 Semver 规范(主版本号-次版本号-修订版本号),我们会在 minor 版本新增 feature 或组件,在 patch 版本我们仅会进行 bug 修复,而不会做新功能更新。但不同 minor 版本之间可能存在样式上的调整,当你需要升级时,我们推荐你在 changelog 页面使用版本 Diff 功能,检查所有变更并确实是否对你的业务系统有影响。
+-   Semi 版本号遵循 Semver 规范(主版本号-次版本号-修订版本号),我们会在 minor 版本新增 feature 或组件,在 patch 版本我们仅会进行 bug 修复,而不会做新功能更新。**但不同 minor 版本之间可能存在样式上的调整**,当你需要升级时,我们推荐你在 changelog 页面使用版本 Diff 功能,检查所有变更并确实是否对你的业务系统有影响。
 -   后续所有新 Feature、新组件都会基于 2.x 版本进行开发,我们推荐业务方尽可能地保持使用最新版本
 -   2.x 各版本之间,API 会保持**向前兼容**
--   1.x 各版本之间,API 也会保持**向前兼容**, 1.x 后续会停止迭代。由 1.x 升级到 2.x 时,会包含 breaking change,具体升级注意事项请查阅文档
+-   1.x 各版本之间,API 也会保持**向前兼容**。由 1.x 升级到 2.x 时,会包含 breaking change,具体升级注意事项请查阅文档
 -   0.x 版本目前已停止更新,当且仅当必须进行 bugfix 时才会进行 hotfix 更新。由 0.x 升级至 1.x 时,会包含 breaking change,具体升级注意事项请查阅文档
 
+#### Semi 的默认的主题风格跟我们系统的定位不符,可以配置另外的主题吗?
+
+- 具体请参考 [定制主题](/zh-CN/start/customize-theme) 。Semi 提供**多达 2300+ Design Token 允许用户进行深度定制**,无论你是研发还是设计师,在[Semi DSM](/dsm) 里可以非常方便地进行样式层配置,并在代码、设计稿始终保持双向同步。基于 Semi 你可以**低成本定制属于你自己的 Design System**
+- 并且在使用时,你也只需要在 webpack.config.js 里指定使用的主题包名即可完成接入(需接入 Semi 插件)。
+
 #### Semi 是否支持 Tree Shaking
 
 -   Semi 执行发包时,发布的其实是 esModule 源码,因此天然支持 tree shaking,不需要再进行额外的配置。
@@ -42,10 +47,6 @@ Semi 目前支持 14 种语言,具体使用可以查阅 [Semi·LocaleProvider]
 
 我们的样式基于 Scss,与此我们还使用了 CSS Variable 作为色盘变量。色盘变量和通用变量挂载在 body 下。不使用 CSS Module 是因为我们希望有固定的 className,为业务方保留修改/覆盖 Semi 样式的能力(虽然不提倡,但有些业务场景下确实需要)
 
-#### Semi 的默认的主题风格跟我们系统的定位不符,可以配置另外的主题吗?
-
-具体请参考 [定制主题](/zh-CN/start/customize-theme) 。在[Semi DSM](/dsm) 里可以进行样式的配置,你只需要在 webpack.config.js 里指定使用的主题包名即可完成接入(需接入 Semi 插件)。
-
 #### 为什么 Tooltip、Typography 不默认配置 word-break 样式?
 
 不同语言内容(纯英文、中文、中英文混合)对 word-break 的需求不太一致,所以组件层没有做这个预设。可以根据需求,使用 CSS 进行设置。