From 59d9b58f9deeff20cd4848f1d36371e2499d7787 Mon Sep 17 00:00:00 2001 From: Stuart Meeks Date: Wed, 19 Aug 2026 15:29:57 +0000 Subject: [PATCH] fix: point the Documentation nav item at the wiki Closes #63. The "Documentation" nav item opened the README anchor (https://github.com/StuartMeeks/Snipdeck#readme). User-facing docs live in the wiki; the README is only the project intro, so the nav item now opens https://github.com/StuartMeeks/Snipdeck/wiki. The nav test asserted DocumentationUrl against itself, which would have passed whatever the constant held, so it now pins the literal wiki URL instead. Co-Authored-By: Claude Opus 5 (1M context) --- CHANGELOG.md | 2 ++ src/Snipdeck.Core/ViewModels/ShellViewModel.cs | 7 +++++-- .../ViewModels/ShellViewModelNavTests.cs | 6 ++++-- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 837846a..f411de7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Changed +- The **Documentation** navigation item now opens the project wiki rather than the + README, so it lands on the user-facing documentation. - Migrated the test suites to xUnit v3 on Microsoft Testing Platform, replacing the VSTest stack. Development-only; the shipped app is unaffected. - Refreshed dependencies to their latest stable releases, including the Windows diff --git a/src/Snipdeck.Core/ViewModels/ShellViewModel.cs b/src/Snipdeck.Core/ViewModels/ShellViewModel.cs index d60b499..147868b 100644 --- a/src/Snipdeck.Core/ViewModels/ShellViewModel.cs +++ b/src/Snipdeck.Core/ViewModels/ShellViewModel.cs @@ -19,8 +19,11 @@ public sealed partial class ShellViewModel : ObservableObject { public const string AllTagsSentinel = "All"; - /// The project documentation opened by the "Documentation" nav item. - public const string DocumentationUrl = "https://github.com/StuartMeeks/Snipdeck#readme"; + /// + /// The project documentation opened by the "Documentation" nav item. The wiki + /// is the home for user-facing docs; the README is only the project intro. + /// + public const string DocumentationUrl = "https://github.com/StuartMeeks/Snipdeck/wiki"; // Glyph for the "All" tag entry (Segoe Fluent Icons "Filter"). private const string _allTagsGlyph = "\uE71C"; diff --git a/tests/Snipdeck.Core.Tests/ViewModels/ShellViewModelNavTests.cs b/tests/Snipdeck.Core.Tests/ViewModels/ShellViewModelNavTests.cs index 76aad2f..dd54461 100644 --- a/tests/Snipdeck.Core.Tests/ViewModels/ShellViewModelNavTests.cs +++ b/tests/Snipdeck.Core.Tests/ViewModels/ShellViewModelNavTests.cs @@ -175,14 +175,16 @@ public async Task SelectTag_reapplies_the_snip_list_when_the_same_tag_is_re_invo } [Fact] - public async Task OpenDocumentation_opens_the_readme_url() + public async Task OpenDocumentation_opens_the_wiki_url() { var (vm, links, _, _) = await BuildAsync(); await vm.OpenDocumentationAsync(); Assert.Equal(1, links.OpenCount); - Assert.Equal(ShellViewModel.DocumentationUrl, links.LastOpenedUrl); + // Asserted as a literal, not against the constant: comparing the constant + // to itself would pass whatever the nav item actually pointed at. + Assert.Equal("https://github.com/StuartMeeks/Snipdeck/wiki", links.LastOpenedUrl); } } }