diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml index 1322e51c9..65720c2ec 100644 --- a/.github/workflows/api-docs.yml +++ b/.github/workflows/api-docs.yml @@ -1,8 +1,8 @@ -name: Build and publish API docs +name: Build and publish v2 API docs on: push: - branches: [v1_release, v2_develop] + branches: [v2_release, v2_develop] permissions: id-token: write @@ -10,7 +10,7 @@ permissions: jobs: deploy: - name: Build and Deploy API docs to github-pages ${{ github.ref_name }} + name: Build and Deploy v2 API docs to github-pages ${{ github.ref_name }} environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} @@ -20,7 +20,6 @@ jobs: uses: actions/checkout@v4 - name: DocFX Build - #if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' working-directory: docfx run: | dotnet tool install -g docfx @@ -30,27 +29,15 @@ jobs: continue-on-error: false - name: Setup Pages - #if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' uses: actions/configure-pages@v5 - name: Upload artifact - #if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop' uses: actions/upload-pages-artifact@v3 with: path: docfx/_site - name: Deploy to GitHub Pages - 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 }}"}' 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 f781c360b..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.Gui/api/Terminal.Gui.html +> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/ ## 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