Skip to content

Commit 94bb9dc

Browse files
authored
Merge pull request #34 from tgiachi/docs/fixes
docs: zero docfx warnings, GitHub navbar icon, README title alignment
2 parents 7db25b9 + ff1f932 commit 94bb9dc

6 files changed

Lines changed: 22 additions & 7 deletions

File tree

docs/templates/squidstd/public/main.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,8 @@ table > thead { background-color: rgba(75, 180, 189, 0.12); }
5252

5353
/* Affix (right-hand "In this article") active marker. */
5454
.affix ul li.active > a { color: var(--sqd-brand); border-left-color: var(--sqd-brand); }
55+
56+
/* Package READMEs use <h1 align="center"> for GitHub/NuGet; on the site keep typography consistent. */
57+
article h1[align] {
58+
text-align: start;
59+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// SquidStd DocFX modern-template extensions.
2+
export default {
3+
iconLinks: [
4+
{
5+
icon: 'github',
6+
href: 'https://github.com/tgiachi/squid-std',
7+
title: 'GitHub',
8+
},
9+
],
10+
}

src/SquidStd.Services.Core/Extensions/RegisterDefaultServicesExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ public IContainer RegisterEventBusService()
131131

132132
/// <summary>
133133
/// Registers the recursive file watcher service as a singleton resolving the event bus.
134-
/// Not part of <see cref="RegisterCoreServices()" />: opt in, then call
135-
/// <see cref="Core.Interfaces.Files.IFileWatcherService.Watch(string)" /> for the directories to watch.
134+
/// Not part of <c>RegisterCoreServices</c>: opt in, then call
135+
/// <see cref="IFileWatcherService.Watch(string)" /> for the directories to watch.
136136
/// </summary>
137137
/// <param name="debounceDelay">Optional debounce window; defaults to 300ms when null.</param>
138138
/// <returns>The same container for chaining.</returns>

src/SquidStd.Tui/TuiView.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ namespace SquidStd.Tui;
88
/// <summary>
99
/// Base class for views: a Terminal.Gui <see cref="Window" /> that owns a typed ViewModel and a
1010
/// <see cref="ViewBinder" />. Implement <see cref="BuildLayout" /> to create widgets and
11-
/// <see cref="Bind" /> to declare bindings; both run once during <see cref="Initialize" />.
11+
/// <see cref="Bind" /> to declare bindings; both run once during <see cref="ITuiView.Initialize" />.
1212
/// </summary>
1313
/// <typeparam name="TViewModel">The ViewModel type for this view.</typeparam>
1414
public abstract class TuiView<TViewModel> : Window, ITuiView
1515
where TViewModel : TuiViewModel
1616
{
1717
private readonly ViewBinder _binder;
1818

19-
/// <summary>The bound ViewModel. Set by the navigator before <see cref="Initialize" />.</summary>
19+
/// <summary>The bound ViewModel. Set by the navigator before <see cref="ITuiView.Initialize" />.</summary>
2020
protected TViewModel ViewModel { get; private set; } = null!;
2121

2222
protected TuiView()

src/SquidStd.Vfs.Database/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ The `VfsFileEntity` table is created automatically by FreeSql on first access (s
4747
## Related
4848

4949
- Tutorial: [Virtual filesystem](https://tgiachi.github.io/squid-std/tutorials/vfs.html)
50-
- [`SquidStd.Vfs`](../SquidStd.Vfs/README.md) - core backends and decorators
51-
- [`SquidStd.Database`](../SquidStd.Database/README.md) - required database module
50+
- [`SquidStd.Vfs`](https://tgiachi.github.io/squid-std/articles/vfs.html) - core backends and decorators
51+
- [`SquidStd.Database`](https://tgiachi.github.io/squid-std/articles/database.html) - required database module
5252

5353
## License
5454

src/SquidStd.Vfs.S3/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For native AWS with the default credential chain, omit `AccessKey`/`SecretKey` a
4848
## Related
4949

5050
- Tutorial: [Virtual filesystem](https://tgiachi.github.io/squid-std/tutorials/vfs.html)
51-
- [`SquidStd.Vfs`](../SquidStd.Vfs/README.md) - core backends and decorators
51+
- [`SquidStd.Vfs`](https://tgiachi.github.io/squid-std/articles/vfs.html) - core backends and decorators
5252

5353
## License
5454

0 commit comments

Comments
 (0)