diff --git a/README.md b/README.md index e084e35ab90..44fec622f43 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ With prompt flow, you will be able to: - **Create and iteratively develop flow** - Create executable [flows](https://microsoft.github.io/promptflow/concepts/concept-flows.html) that link LLMs, prompts, Python code and other [tools](https://microsoft.github.io/promptflow/concepts/concept-tools.html) together. - - Debug and iterate your flows, especially the [interaction with LLMs](https://microsoft.github.io/promptflow/concepts/concept-connections.html) with ease. + - Debug and iterate your flows, especially [tracing interaction with LLMs](https://microsoft.github.io/promptflow/how-to-guides/tracing/index.html) with ease. - **Evaluate flow quality and performance** - Evaluate your flow's quality and performance with larger datasets. - Integrate the testing and evaluation into your CI/CD system to ensure quality of your flow. diff --git a/docs/index.md b/docs/index.md index 9e2fbe2a0a5..d42f8bb4602 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ html_theme.sidebar_secondary.remove: true With prompt flow, you will be able to: - **Create [flows](./concepts/concept-flows.md)** that link [LLMs](./reference/tools-reference/llm-tool.md), [prompts](./reference/tools-reference/prompt-tool.md), [Python](./reference/tools-reference/python-tool.md) code and other [tools](./concepts/concept-tools.md) together in a executable workflow. -- **Debug and iterate your flows**, especially the interaction with LLMs with ease. +- **Debug and iterate your flows**, especially [tracing interaction with LLMs](how-to-guides/tracing/index.md) with ease. - **Evaluate your flows**, calculate quality and performance metrics with larger datasets. - **Integrate the testing and evaluation into your CI/CD system** to ensure quality of your flow. - **Deploy your flows** to the serving platform you choose or integrate into your app's code base easily. @@ -39,6 +39,7 @@ This documentation site contains guides for prompt flow [sdk, cli](https://pypi. - header: "📒 How-to Guides" content: " Articles guide user to complete a specific task in prompt flow.

+ - [Tracing](how-to-guides/tracing/index.md)
- [Develop a flow](how-to-guides/develop-a-flex-flow/index.md)
- [Run and evaluate a flow](how-to-guides/run-and-evaluate-a-flow/index.md)
- [Deploy a flow](how-to-guides/deploy-a-flow/index.md)
diff --git a/scripts/docs/_static/custom.css b/scripts/docs/_static/custom.css index 0a9fc6c1913..2b395314f5e 100644 --- a/scripts/docs/_static/custom.css +++ b/scripts/docs/_static/custom.css @@ -20,17 +20,33 @@ max-width: 70em; } +/* Background color for feature announcement */ html[data-theme="light"] { - --header-announcement-color: #fff070; + --header-announcement-color: #3278e5; } html[data-theme="dark"] { - --header-announcement-color: #4d4d00; + --header-announcement-color: #67d6ed; } .bd-header-announcement { background: var(--header-announcement-color); } +/* Background color for feature announcement */ + +/* Background color for warning announcement */ +/*html[data-theme="light"] {*/ +/* --header-announcement-color: #fff070;*/ +/*}*/ + +/*html[data-theme="dark"] {*/ +/* --header-announcement-color: #4d4d00;*/ +/*}*/ + +/*.bd-header-announcement {*/ +/* background: var(--header-announcement-color);*/ +/*}*/ +/* Background color for warning announcement */ /* (A) LIGHTBOX BACKGROUND */ #lightbox { diff --git a/scripts/docs/conf.py b/scripts/docs/conf.py index 7f4853fb25c..b1cbb427d0d 100644 --- a/scripts/docs/conf.py +++ b/scripts/docs/conf.py @@ -112,10 +112,11 @@ "show_toc_level": 1, "navbar_align": "left", # [left, content, right] For testing that the navbar items align properly "navbar_center": ["navbar-nav"], - "announcement": "[IMPORTANT] Please uninstall existing promptflow and sub packages before you " - "upgrade from promptflow<=1.7.0 to newer version. Reach " - "" - "here for more details.", + "announcement": "🚀" + "Promptflow 1.13.0 has released! Try new feature: " + "" + "tracing interaction with LLMs." + "", "show_nav_level": 1, } diff --git a/src/promptflow/README.md b/src/promptflow/README.md index 3e74ff0633e..cb548a8b866 100644 --- a/src/promptflow/README.md +++ b/src/promptflow/README.md @@ -24,7 +24,7 @@ With prompt flow, you will be able to: - **Create and iteratively develop flow** - Create executable [flows](https://microsoft.github.io/promptflow/concepts/concept-flows.html) that link LLMs, prompts, Python code and other [tools](https://microsoft.github.io/promptflow/concepts/concept-tools.html) together. - - Debug and iterate your flows, especially the [interaction with LLMs](https://microsoft.github.io/promptflow/concepts/concept-connections.html) with ease. + - Debug and iterate your flows, especially [tracing interaction with LLMs](https://microsoft.github.io/promptflow/how-to-guides/tracing/index.html) with ease. - **Evaluate flow quality and performance** - Evaluate your flow's quality and performance with larger datasets. - Integrate the testing and evaluation into your CI/CD system to ensure quality of your flow.