From 3b104b85f01eda1d748b967bd21dfe8c37d09f19 Mon Sep 17 00:00:00 2001 From: Tigger Kindel Date: Fri, 1 Dec 2023 20:23:33 -0700 Subject: [PATCH] Updated API docs to clearly show v2 --- docfx/articles/newinv2.md | 3 +++ docfx/articles/overview.md | 2 +- docfx/index.md | 5 ++++- docfx/toc.yml | 2 ++ 4 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 docfx/articles/newinv2.md diff --git a/docfx/articles/newinv2.md b/docfx/articles/newinv2.md new file mode 100644 index 000000000..72ebe6b12 --- /dev/null +++ b/docfx/articles/newinv2.md @@ -0,0 +1,3 @@ +# Terminal.Gui v2 + +Checkout this Discussion: https://github.com/gui-cs/Terminal.Gui/discussions/2448 \ No newline at end of file diff --git a/docfx/articles/overview.md b/docfx/articles/overview.md index 983c2a201..9fdf409f1 100644 --- a/docfx/articles/overview.md +++ b/docfx/articles/overview.md @@ -1,4 +1,4 @@ -# Terminal.Gui API Overview +# Terminal.Gui v2 API Overview `Terminal.Gui` is a library intended to create console-based applications using C#. The framework has been designed to make it diff --git a/docfx/index.md b/docfx/index.md index 879f88300..6ef640f86 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -1,4 +1,6 @@ -# Terminal.Gui - Cross Platform Terminal UI toolkit for .NET +# Terminal.Gui v2 - Cross Platform Terminal UI toolkit for .NET + +**NOTE** v2 is still in development (see the `v2_develop` branch). The current stable version of v1 is in the `develop` branch, and released from main. A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. @@ -8,6 +10,7 @@ A toolkit for building rich console apps for .NET, .NET Core, and Mono that work ## Terminal.Gui API Documentation +* [What's new in v2](~/articles/newinv2.md) * [API Reference](~/api/Terminal.Gui/Terminal.Gui.yml) * [Views and controls built into the Terminal.Gui library](~/articles/views.md) * [Terminal.Gui API Overview](~/articles/overview.md) diff --git a/docfx/toc.yml b/docfx/toc.yml index 701c0fd50..1a42876e8 100644 --- a/docfx/toc.yml +++ b/docfx/toc.yml @@ -1,3 +1,5 @@ +- name: What's new in Terminal.Gui v2 + href: articles/newinv2.md - name: Overview href: articles/overview.md - name: Conceptual Docs