From f4d4a257040ac5b4d21d78e3c56a01387e77c32e Mon Sep 17 00:00:00 2001 From: Tig Date: Thu, 12 Jun 2025 12:16:54 -0600 Subject: [PATCH 1/5] pre-alpha -> alpha (#4158) --- .github/workflows/api-docs.yml | 19 +++++++++---------- GitVersion.yml | 4 ++-- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index fb2584163..1322e51c9 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -17,7 +17,6 @@ jobs: runs-on: windows-latest steps: - name: Checkout - #if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' uses: actions/checkout@v4 - name: DocFX Build @@ -41,17 +40,17 @@ jobs: path: docfx/_site - name: Deploy to GitHub Pages - if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' + if: github.ref_name github.ref_name == 'v2_develop' || github.ref_name == 'v2_release' id: deployment uses: actions/deploy-pages@v4 with: token: ${{ secrets.GITHUB_TOKEN }} - - name: v2_develop Repository Dispatch ${{ github.ref_name }} - if: github.ref_name == 'v2_develop' - uses: peter-evans/repository-dispatch@v3 - with: - token: ${{ secrets.V2DOCS_TOKEN }} - repository: gui-cs/Terminal.GuiV2Docs - event-type: v2_develop_push - client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}' + # - name: v2_develop Repository Dispatch ${{ github.ref_name }} + # if: github.ref_name == 'v2_develop' + # uses: peter-evans/repository-dispatch@v3 + # with: + # token: ${{ secrets.V2DOCS_TOKEN }} + # repository: gui-cs/Terminal.GuiV2Docs + # event-type: v2_develop_push + # client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}' diff --git a/GitVersion.yml b/GitVersion.yml index b2ba90ee1..825fac8ba 100644 --- a/GitVersion.yml +++ b/GitVersion.yml @@ -33,8 +33,8 @@ branches: main: # Matches the v2_release branch regex: ^v2_release$ - # Uses 'prealpha' as pre-release label before official release - label: prealpha + # Uses 'alpha' as pre-release label before `beta` + label: alpha # Increments patch version (x.y.z+1) on commits increment: Patch # Specifies v2_develop as the source branch From 40d6250427cdc550bfb3c302cc89c77d0e5ddcc2 Mon Sep 17 00:00:00 2001 From: Tig Date: Thu, 12 Jun 2025 12:18:25 -0600 Subject: [PATCH 2/5] Migrating api docs --- .github/workflows/api-docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index fb2584163..cb570317f 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -41,17 +41,17 @@ jobs: path: docfx/_site - name: Deploy to GitHub Pages - if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' + if: github.ref_name == 'v2_release' || github.ref_name == 'v2_develop' id: deployment uses: actions/deploy-pages@v4 with: token: ${{ secrets.GITHUB_TOKEN }} - - name: v2_develop Repository Dispatch ${{ github.ref_name }} + - name: v1_release Repository Dispatch ${{ github.ref_name }} if: github.ref_name == 'v2_develop' uses: peter-evans/repository-dispatch@v3 with: token: ${{ secrets.V2DOCS_TOKEN }} - repository: gui-cs/Terminal.GuiV2Docs + repository: gui-cs/Terminal.GuiV1Docs event-type: v2_develop_push client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}' From 5e96525522e22fa0b6ebb0aaae52df3ecd8b9f8f Mon Sep 17 00:00:00 2001 From: Tig Date: Thu, 12 Jun 2025 12:22:11 -0600 Subject: [PATCH 3/5] Migrating api docs 2 --- docfx/docs/index.md | 2 +- docfx/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docfx/docs/index.md b/docfx/docs/index.md index f781c360b..37673839f 100644 --- a/docfx/docs/index.md +++ b/docfx/docs/index.md @@ -3,7 +3,7 @@ Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui. > [!NOTE] -> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV2Docs/ ## Getting Started diff --git a/docfx/index.md b/docfx/index.md index 9a2ee0b01..d804e28fe 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -21,7 +21,7 @@ A toolkit for building rich console apps for .NET that run on Windows, the Mac, ![Sample](images/sample.gif) > [!NOTE] -> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/ ## Features From e0e87a2b401eb9c342d97d3c820b0c3b4cb808e4 Mon Sep 17 00:00:00 2001 From: Tig Date: Thu, 12 Jun 2025 12:27:06 -0600 Subject: [PATCH 4/5] Migrating api docs 4 --- .github/workflows/api-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index 075ee96dc..b270a5234 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -40,7 +40,7 @@ jobs: path: docfx/_site - name: Deploy to GitHub Pages - if: github.ref_name github.ref_name == 'v2_develop' || github.ref_name == 'v2_release' + if: github.ref_name == 'v2_release' || github.ref_name == 'v2_develop' id: deployment uses: actions/deploy-pages@v4 with: From 258824dba63d99a66074022de52ecbaa21af2c08 Mon Sep 17 00:00:00 2001 From: Tig Date: Thu, 12 Jun 2025 13:33:06 -0600 Subject: [PATCH 5/5] Updated readme etc for Alpha --- README.md | 20 ++++++++++---------- docfx/docs/index.md | 5 ++++- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0e81f8ae1..b086462f3 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ The premier toolkit for building rich console apps for Windows, the Mac, and Lin > :warning: **Note:** > `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality. -* The current `prealpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui) +* The current `Alpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui) > :warning: **Note:** -> Developers starting new TUI projects are encouraged to target `v2`. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable. +> Developers starting new TUI projects are encouraged to target `v2 Alpha`. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable. ![Sample app](docfx/images/sample.gif) @@ -46,27 +46,27 @@ There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner) # Documentation -The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.GuiV2Docs](https://gui-cs.github.io/Terminal.GuiV2Docs/). +The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.Gui](https://gui-cs.github.io/Terminal.Gui). ## Getting Started -- [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application -- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/migratingfromv1.md) - Complete guide for upgrading existing applications -- [What's New in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.md) - Overview of new features and improvements +- [Getting Started](https://gui-cs.github.io/Terminal.Gui/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application +- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.Gui/docs/migratingfromv1.md) - Complete guide for upgrading existing applications +- [What's New in v2](https://gui-cs.github.io/Terminal.Gui/docs/newinv2.md) - Overview of new features and improvements ## API Reference -For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.App.html). +For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html). # Installing Use NuGet to install the `Terminal.Gui` NuGet package: -## v2 Pre-Alpha +## v2 Alpha (Infrequently updated, but stable enough for production use) ``` -dotnet add package Terminal.Gui --version "2.0.0-prealpha.*" +dotnet add package Terminal.Gui --version "2.0.0-alpha.*" ``` ## v2 Develop @@ -79,7 +79,7 @@ dotnet add package Terminal.Gui --version "2.0.0-develop.*" ## Legacy v1 ``` -dotnet add package Terminal.Gui +dotnet add package Terminal.Gui --version "1.* ``` Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates). diff --git a/docfx/docs/index.md b/docfx/docs/index.md index 37673839f..830ec3c19 100644 --- a/docfx/docs/index.md +++ b/docfx/docs/index.md @@ -1,9 +1,12 @@ # Terminal.Gui Documentation +> [!IMPORTANT] +> Terminal.Gui v2 "Alpha" has been released. + Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui. > [!NOTE] -> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV2Docs/ +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/ ## Getting Started