Skip to content

Commit 21ccaac

Browse files
committed
docs: add tutorial cross-links to README and reference docs
1 parent 0f54a0c commit 21ccaac

5 files changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ dotnet run --project Examples/DemoApp
261261

262262
| Guide | Description |
263263
|-------|-------------|
264+
| **[Tutorials](docs/tutorials/01-hello-window.md)** | Step-by-step guides: Hello Window → Dashboard → Settings App |
264265
| **[Examples Gallery](docs/EXAMPLES.md)** | All examples with screenshots |
265266
| **[Fluent Builders](docs/BUILDERS.md)** | WindowBuilder and control builder APIs |
266267
| **[Controls Reference](docs/CONTROLS.md)** | Complete guide to all 30+ UI controls |

docs/BUILDERS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Fluent Builders Reference
22

3+
> **New to SharpConsoleUI?** Start with the [Tutorials](tutorials/01-hello-window.md) — they cover `WindowBuilder` in context from the very first step.
4+
35
SharpConsoleUI provides fluent builder APIs for creating windows and controls with clean, chainable syntax.
46

57
## Table of Contents

docs/CONTROLS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
SharpConsoleUI provides 30+ built-in UI controls for building rich console applications.
44

5+
> **New to SharpConsoleUI?** Start with the [Tutorials](tutorials/01-hello-window.md) — step-by-step guides that build real apps from scratch.
6+
57
## Table of Contents
68

79
- [Overview](#overview)

docs/GRADIENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Gradients
22

3+
> **New to SharpConsoleUI?** Gradients are covered hands-on in [Tutorial 3: Settings App](tutorials/03-settings-app.md).
4+
35
SharpConsoleUI supports gradient colors for both text and window backgrounds, extending the existing `ColorGradient` system.
46

57
## Table of Contents

docs/MARKUP_SYNTAX.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Markup Syntax Reference
22

3+
> **New to SharpConsoleUI?** Start with the [Tutorials](tutorials/01-hello-window.md) — markup is introduced in Tutorial 1.
4+
35
SharpConsoleUI includes a native markup parser that uses Spectre-compatible `[tag]text[/]` syntax. All markup is parsed directly into typed `Cell` structs -- no ANSI intermediate format, no external dependencies required.
46

57
## Basic Syntax

0 commit comments

Comments
 (0)