Skip to content

Commit bd698ef

Browse files
committed
Simply documentation for terminal integration
1 parent 9057402 commit bd698ef

File tree

2 files changed

+27
-28
lines changed

2 files changed

+27
-28
lines changed

site/docs/getting-started.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,23 @@ using (logger.BeginScope(new LogProperties { ("traceId", "abc-123") }))
111111
## 5. Terminal output (optional)
112112

113113
```csharp
114+
using XenoAtom.Logging;
114115
using XenoAtom.Logging.Writers;
115-
using XenoAtom.Terminal;
116-
using XenoAtom.Terminal.Backends;
117116

118-
using (Terminal.Open(new InMemoryTerminalBackend(), force: true))
117+
var config = new LogManagerConfig
119118
{
120-
var writer = new TerminalLogWriter(Terminal.Instance);
121-
var config = new LogManagerConfig();
122-
config.RootLogger.Writers.Add(writer);
119+
RootLogger =
120+
{
121+
Writers =
122+
{
123+
new TerminalLogWriter()
124+
}
125+
}
126+
};
123127

124-
LogManager.Initialize(config);
125-
LogManager.GetLogger("App").InfoMarkup("[green]ready[/]");
126-
LogManager.Shutdown();
127-
}
128+
LogManager.Initialize(config);
129+
LogManager.GetLogger("App").InfoMarkup("[green]ready[/]");
130+
LogManager.Shutdown();
128131
```
129132

130133
See [Terminal Integration](terminal.md) for styling, markup, and `LogControl`.

site/docs/terminal.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ It supports:
1616

1717
For details on template-based text formatting and segment kinds, see [Log Formatters](log-formatter.md).
1818

19+
For terminal primitives, capabilities, and runtime behavior, see the `XenoAtom.Terminal` docs: https://xenoatom.github.io/terminal/docs/terminal/
20+
1921
## Why a separate package
2022

2123
- `XenoAtom.Logging` stays dependency-minimal and does not use `System.Console`.
@@ -26,29 +28,23 @@ For details on template-based text formatting and segment kinds, see [Log Format
2628
```csharp
2729
using XenoAtom.Logging;
2830
using XenoAtom.Logging.Writers;
29-
using XenoAtom.Terminal;
30-
using XenoAtom.Terminal.Backends;
3131

32-
var backend = new InMemoryTerminalBackend();
33-
using (Terminal.Open(backend, force: true))
32+
var config = new LogManagerConfig
3433
{
35-
var config = new LogManagerConfig
34+
RootLogger =
3635
{
37-
RootLogger =
36+
MinimumLevel = LogLevel.Info,
37+
Writers =
3838
{
39-
MinimumLevel = LogLevel.Info,
40-
Writers =
41-
{
42-
new TerminalLogWriter(Terminal.Instance)
43-
}
39+
new TerminalLogWriter()
4440
}
45-
};
41+
}
42+
};
4643

47-
LogManager.Initialize(config);
48-
var logger = LogManager.GetLogger("Sample.Terminal");
49-
logger.Info("Hello terminal");
50-
LogManager.Shutdown();
51-
}
44+
LogManager.Initialize(config);
45+
var logger = LogManager.GetLogger("Sample.Terminal");
46+
logger.Info("Hello terminal");
47+
LogManager.Shutdown();
5248
```
5349

5450
## Writers
@@ -83,7 +79,7 @@ var writer = new TerminalLogControlWriter(logControl)
8379
`TerminalLogWriter` enables rich formatting by default:
8480

8581
```csharp
86-
var writer = new TerminalLogWriter(Terminal.Instance)
82+
var writer = new TerminalLogWriter()
8783
{
8884
EnableRichFormatting = true,
8985
EnableMarkupMessages = true,

0 commit comments

Comments
 (0)