Skip to content

Commit f1dec3a

Browse files
committed
merged v2_develop into v2_release
2 parents 104305b + 258824d commit f1dec3a

4 files changed

Lines changed: 18 additions & 28 deletions

File tree

.github/workflows/api-docs.yml

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
name: Build and publish API docs
1+
name: Build and publish v2 API docs
22

33
on:
44
push:
5-
branches: [v1_release, v2_develop]
5+
branches: [v2_release, v2_develop]
66

77
permissions:
88
id-token: write
99
pages: write
1010

1111
jobs:
1212
deploy:
13-
name: Build and Deploy API docs to github-pages ${{ github.ref_name }}
13+
name: Build and Deploy v2 API docs to github-pages ${{ github.ref_name }}
1414
environment:
1515
name: github-pages
1616
url: ${{ steps.deployment.outputs.page_url }}
@@ -20,7 +20,6 @@ jobs:
2020
uses: actions/checkout@v4
2121

2222
- name: DocFX Build
23-
#if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop'
2423
working-directory: docfx
2524
run: |
2625
dotnet tool install -g docfx
@@ -30,27 +29,15 @@ jobs:
3029
continue-on-error: false
3130

3231
- name: Setup Pages
33-
#if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop'
3432
uses: actions/configure-pages@v5
3533

3634
- name: Upload artifact
37-
#if: github.ref_name == 'v1_release' || github.ref_name == 'v1_develop'
3835
uses: actions/upload-pages-artifact@v3
3936
with:
4037
path: docfx/_site
4138

4239
- name: Deploy to GitHub Pages
43-
if: github.ref_name github.ref_name == 'v2_develop' || github.ref_name == 'v2_release'
4440
id: deployment
4541
uses: actions/deploy-pages@v4
4642
with:
4743
token: ${{ secrets.GITHUB_TOKEN }}
48-
49-
# - name: v2_develop Repository Dispatch ${{ github.ref_name }}
50-
# if: github.ref_name == 'v2_develop'
51-
# uses: peter-evans/repository-dispatch@v3
52-
# with:
53-
# token: ${{ secrets.V2DOCS_TOKEN }}
54-
# repository: gui-cs/Terminal.GuiV2Docs
55-
# event-type: v2_develop_push
56-
# client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The premier toolkit for building rich console apps for Windows, the Mac, and Lin
1616
> :warning: **Note:**
1717
> `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
1818
19-
* The current `prealpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui)
19+
* The current `Alpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui)
2020

2121
> :warning: **Note:**
22-
> 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.
22+
> 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.
2323
2424
![Sample app](docfx/images/sample.gif)
2525

@@ -46,27 +46,27 @@ There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner)
4646

4747
# Documentation
4848

49-
The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.GuiV2Docs](https://gui-cs.github.io/Terminal.GuiV2Docs/).
49+
The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.Gui](https://gui-cs.github.io/Terminal.Gui).
5050

5151
## Getting Started
5252

53-
- [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application
54-
- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/migratingfromv1.md) - Complete guide for upgrading existing applications
55-
- [What's New in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.md) - Overview of new features and improvements
53+
- [Getting Started](https://gui-cs.github.io/Terminal.Gui/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application
54+
- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.Gui/docs/migratingfromv1.md) - Complete guide for upgrading existing applications
55+
- [What's New in v2](https://gui-cs.github.io/Terminal.Gui/docs/newinv2.md) - Overview of new features and improvements
5656

5757
## API Reference
5858

59-
For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.App.html).
59+
For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html).
6060

6161
# Installing
6262

6363
Use NuGet to install the `Terminal.Gui` NuGet package:
6464

65-
## v2 Pre-Alpha
65+
## v2 Alpha
6666

6767
(Infrequently updated, but stable enough for production use)
6868
```
69-
dotnet add package Terminal.Gui --version "2.0.0-prealpha.*"
69+
dotnet add package Terminal.Gui --version "2.0.0-alpha.*"
7070
```
7171

7272
## v2 Develop
@@ -79,7 +79,7 @@ dotnet add package Terminal.Gui --version "2.0.0-develop.*"
7979
## Legacy v1
8080

8181
```
82-
dotnet add package Terminal.Gui
82+
dotnet add package Terminal.Gui --version "1.*
8383
```
8484

8585
Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates).

docfx/docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Terminal.Gui Documentation
22

3+
> [!IMPORTANT]
4+
> Terminal.Gui v2 "Alpha" has been released.
5+
36
Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui.
47

58
> [!NOTE]
6-
> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html
9+
> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/
710
811
## Getting Started
912

docfx/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A toolkit for building rich console apps for .NET that run on Windows, the Mac,
2121
![Sample](images/sample.gif)
2222

2323
> [!NOTE]
24-
> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html
24+
> This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/
2525
2626
## Features
2727

0 commit comments

Comments
 (0)