From 3ee6149f02286c9a403ce7ed1019af6139627eee Mon Sep 17 00:00:00 2001 From: Travis Spomer <16262858+TravisSpomer@users.noreply.github.com> Date: Mon, 6 Mar 2023 15:22:58 -0800 Subject: [PATCH] Updating docs --- README.md | 8 ++++++-- docs/index.md | 9 +++++---- docs/integration.md | 16 ++++++++-------- docs/json.md | 8 ++++++++ 4 files changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index fcf1f33..2a16fb7 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,21 @@ The Fluent UI token pipeline transforms JSON files describing design tokens into source code for eventual use in the Fluent UI libraries. -It's currently a functional prototype, and is not yet designed for use beyond the Fluent UI libraries at this time. The actual token values in the `src/demo` folder are just examples, and they do not represent an evolution of Microsoft's design systems. Not all features shown at Build 2020 are currently available for testing. +This tool was originally designed to process files in Microsoft's proprietary design token format. Our design token files are now in the [W3C Design Token Community Group](https://design-tokens.github.io/community-group/format/) draft standard format, so this tool is no longer required to work with them. + +Do not add new dependencies on this tool. Over time, it is expected that Fluent UI teams will transition from using this tool to using standard open source solutions for consuming design tokens. But while this tool is deprecated, it is still fully functional and will remain so for the foreseeable future. And since this tool can also read DTCG format JSON, existing code written when continues to work even though we no longer use this proprietary format. * **[Documentation site](https://microsoft.github.io/fluentui-token-pipeline/)** * [Source code on GitHub](https://github.com/microsoft/fluentui-token-pipeline) * [`@fluentui/token-pipeline` on NPM](https://www.npmjs.com/package/@fluentui/token-pipeline) -* [Fluent UI design tokens on GitHub](https://github.com/microsoft/fluentui-design-tokens) 🔒 \[WIP\] with links to packages of transformed tokens +* [Fluent UI design tokens on GitHub](https://github.com/microsoft/fluentui-design-tokens) 🔒 with links to packages of transformed tokens --- # The legal stuff +The actual token values in the `src/demo` folder are just examples, and they do not represent an evolution of Microsoft's design systems. + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a diff --git a/docs/index.md b/docs/index.md index f305a5d..3cf35c1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,18 +6,19 @@ title: Fluent UI token pipeline The Fluent UI token pipeline transforms JSON files describing design tokens into source code for eventual use in the Fluent UI libraries. -It's currently a functional prototype, and is not yet designed for use beyond the Fluent UI libraries at this time. The actual token values in the `src/demo` folder are just examples, and they do not represent an evolution of Microsoft's design systems. +This tool was originally designed to process files in Microsoft's proprietary design token format. Our design token files are now in the [W3C Design Token Community Group](https://design-tokens.github.io/community-group/format/) draft standard format, so this tool is no longer required to work with them. # The docs * [Getting started: using the CLI](cli.md) (including as a build step in another repo) * [Getting started: building the pipeline](build.md) * [Token naming reference](naming.md) -* [Token JSON format reference](json.md) -* [Integrating with your UI library](integration.md) +* [Proprietary token JSON format reference](json.md) *(not in use)* + * See also: [W3C Design Token Community Group](https://design-tokens.github.io/community-group/format/) draft standard format +* [Integrating with your UI library](integration.md) *(out of date)* * [The legal stuff](legal.md) # Other links * [`@fluentui/token-pipeline` on NPM](https://www.npmjs.com/package/@fluentui/token-pipeline) -* [Fluent UI design tokens on GitHub](https://github.com/microsoft/fluentui-design-tokens) +* [Fluent UI design tokens on GitHub](https://github.com/microsoft/fluentui-design-tokens) 🔒 diff --git a/docs/integration.md b/docs/integration.md index dba66ea..af87a10 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -4,16 +4,16 @@ title: Integration with the pipeline 🏠 [Home](./) +# This tool has been deprecated + +**This tool is no longer required to consume our design tokens.** Internal teams should reach out to the Fluent token team for guidance on how to proceed. Everyone else: we're glad you're excited! More details on how to consume our design tokens are forthcoming—they aren't quite ready for you to take a dependency just yet. + +Consider the remainder of this page out-of-date. + +--- + # I'm an engineer and someone told me I had to integrate with this pipeline thing. -You're in the right place! First question: are you working on one of the Fluent UI libraries for Microsoft? - -**If yes:** Great! Keep reading, and I'll help you get going. - -**If no:** Great! We're glad you're excited. This project's still in the early stages right now, though, and we'd like to build out a couple of end-to-end workflows and tidy up a bit before adding any official third-party support. But feel free to keep watching this space, and we'll try to be transparent about how things are progressing. - -(By the way, "I" in this document is Travis Spomer. If you answered "Yes" to that question, you can find me on Teams.) - ## Where should I get started? It's probably useful to get familiar with a few things first. Here's what I'd recommend: diff --git a/docs/json.md b/docs/json.md index a7c1693..b3f8efb 100644 --- a/docs/json.md +++ b/docs/json.md @@ -4,6 +4,14 @@ title: Token JSON format reference 🏠 [Home](./) +# This tool has been deprecated + +**The file format described on this page is no longer in use.** Our design token files are now in the [W3C Design Token Community Group](https://design-tokens.github.io/community-group/format/) draft standard format, so this tool is no longer required to work with them. + +Consider the remainder of this page out-of-date. + +--- + # Token JSON format reference This reference assumes that you're familiar with the general concept of design tokens.