Skip to content

Commit b62e826

Browse files
authored
API doc updates (#3928)
1 parent 255114f commit b62e826

File tree

8 files changed

+35
-26
lines changed

8 files changed

+35
-26
lines changed

docfx/aboutbox.png

58.3 KB
Loading

docfx/docs/index.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* **[Extensible UI](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided.
1212
* **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume.
1313
* **[Powerful Layout Engine](layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs.
14-
* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class.
14+
* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [ConfigurationManager](~/api/Terminal.Gui.ConfigurationManager.yml) class.
1515
* **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class.
1616
* **Multi-tasking** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading.
1717
* **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app.
@@ -20,17 +20,22 @@ See [What's New in V2 For more](newinv2.md).
2020

2121
## Conceptual Documentation
2222

23-
* [Guide to Migrating from Terminal.Gui v1](migratingfromv1.md)
24-
* [List of Views](views.md)
25-
* [Layout Engine](layout.md)
26-
* [Navigation](navigation.md)
27-
* [Keyboard API](keyboard.md)
28-
* [Mouse API](mouse.md)
2923
* [Arrangement API](arrangement.md)
3024
* [Configuration and Theme Manager](config.md)
31-
* [Multi-tasking and the Application Main Loop](mainloop.md)
25+
* [Cursor Deep Dive](cursor.md)
3226
* [Cross-platform Driver Model](drivers.md)
3327
* [Dim.Auto Deep Dive](dimauto.md)
28+
* [Drawing](drawing.md)
29+
* [Events Deep Dive](events.md)
30+
* [Keyboard API](keyboard.md)
31+
* [Layout Engine](layout.md)
32+
* [Migrating from Terminal.Gui v1](migratingfromv1.md)
33+
* [Mouse API](mouse.md)
34+
* [Multi-tasking and the Application Main Loop](mainloop.md)
35+
* [Navigation](navigation.md)
36+
* [View Deep Dive](View.md)
37+
* [Views](views.md)
38+
* [Scrolling Deep Dive](scrolling.md)
3439
* [TableView Deep Dive](tableview.md)
3540
* [TreeView Deep Dive](treeview.md)
3641

docfx/docs/toc.yml

+20-16
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,36 @@
66
href: newinv2.md
77
- name: v1 To v2 Migration
88
href: migratingfromv1.md
9-
- name: View Deep Dive
10-
href: View.md
11-
- name: List of Views
12-
href: views.md
13-
- name: Layout Engine
14-
href: layout.md
159
- name: Arrangement
1610
href: arrangement.md
17-
- name: Navigation
18-
href: navigation.md
19-
- name: Scrolling
20-
href: scrolling.md
21-
- name: Keyboard
22-
href: keyboard.md
23-
- name: Mouse
24-
href: mouse.md
2511
- name: Configuration
2612
href: config.md
13+
- name: Cursor
14+
href: cursor.md
15+
- name: Dim.Auto Deep Dive
16+
href: dimauto.md
2717
- name: Drawing
2818
href: drawing.md
2919
- name: Drivers
3020
href: drivers.md
21+
- name: Events Deep Dive
22+
href: events.md
23+
- name: Keyboard
24+
href: keyboard.md
25+
- name: Layout Engine
26+
href: layout.md
27+
- name: Mouse
28+
href: mouse.md
3129
- name: Multi-Tasking
3230
href: mainloop.md
33-
- name: Dim.Auto Deep Dive
34-
href: dimauto.md
31+
- name: Navigation
32+
href: navigation.md
33+
- name: View Deep Dive
34+
href: View.md
35+
- name: View List
36+
href: views.md
37+
- name: Scrolling
38+
href: scrolling.md
3539
- name: TableView Deep Dive
3640
href: tableview.md
3741
- name: TreeView Deep Dive

docfx/images/sample.gif

-1.83 MB
Loading

docfx/images/sample.png

-35.8 KB
Binary file not shown.

docfx/images/wizard.gif

-103 KB
Loading

docfx/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A toolkit for building rich console apps for .NET that run on Windows, the Mac,
88

99
## Terminal.Gui API Documentation
1010

11-
* [Conceptual Documentation](docs/index.md)
11+
* [Conceptual Docs & Deep Dives](docs/index.md)
1212
* [API Reference](~/api/Terminal.Gui.yml)
1313

1414
## UI Catalog

docfx/toc.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- name: Conceptual Docs
1+
- name: Conceptual Docs & Deep Dives
22
href: docs/
33

44
- name: API

0 commit comments

Comments
 (0)