Skip to content

Refresh docs and README for current product surface#522

Merged
NikTilton merged 3 commits into
mainfrom
jschick/docs-refresh
May 14, 2026
Merged

Refresh docs and README for current product surface#522
NikTilton merged 3 commits into
mainfrom
jschick/docs-refresh

Conversation

@jschick04
Copy link
Copy Markdown
Collaborator

Summary

Refresh docs/ and README.md for the current product surface. The previous docs were last touched in June 2023; main has accumulated ~576 commits since, with a lot of new user-visible behavior the docs never covered.

This is a docs-only PR. No source, workflow, or test changes.

Docs restructure

Replaces the old 5-page tutorial-style set with a feature-reference set keyed off the actual product surface (menus / panes / modals).

New pages

  • Home.md — TOC + product summary + supported-OS line.
  • Opening-Logs.mdFile menu (File / Folder / Live), drag-and-drop, command-line .evtx opens, combining logs, Continuously Update / Load New Events, status-bar tokens, Close All.
  • Viewing-Events.md — Tab strip, virtualized event table (configurable columns + drag reorder + drag resize + sort + per-row highlighting), selection (Ctrl+A / Escape), Details pane, on-demand XML.
  • Filtering.md — Filter pane: Basic (categories + evaluators + sub-filters with case-sensitivity caveats), Advanced (Dynamic LINQ with full filterable-property table from ResolvedEvent), Cached, Date, Exclusion semantics, highlighting.
  • Saved-Filters.md — Filter cache (Favorites + Recent) and named filter groups; per-group and bulk import / export; Apply Filters add-and-dedupe semantics.
  • Provider-Databases.md — Why DBs exist, resolution order (MTA → enabled DBs → local fallback), Settings lifecycle states, full eventdbtool subcommand reference (show / create / merge / diff / upgrade) with verbatim Description strings.
  • Settings.md — Time Zone, Databases, Theme, Keyboard Copy Behavior, Logging Level, Pre-release Builds, Expand Display Pane on Selection Change.
  • Keyboard-And-Copy.md — Edit-menu copy modes, how Keyboard Copy Behavior rebinds Ctrl+C, Ctrl+H toggle.
  • Updates-And-Diagnostics.mdHelp menu: Docs, Submit an Issue, Check for Updates, Release Notes, View Logs.

Removed (legacy 2023 pages, replaced)

  • docs/FirstTimeSetup.md
  • docs/ProviderDatabases.md
  • docs/Viewing.md

README

  • Key Features bullets rewritten to cover what's actually shipped (filter groups, filter cache, exclusion + sub-filters, configurable columns + highlighting, configurable Ctrl+C modes, themes, on-demand XML, in-app Release Notes + Debug Log viewer, opt-in pre-release update channel) alongside the originals.
  • Quick Start is now .appinstaller-first.
  • Microsoft.WindowsAppRuntime example bumped 1.21.7 (matches the current appxmanifest dependency).
  • Sideloading paragraph dropped — sideloading is enabled by default on every supported OS.
  • "Auto-updates do not work on 2019" note dropped.
  • Supported OS narrowed to mainstream-supported: Windows 11, Windows Server 2022, Windows Server 2025. Drops Windows 10 (mainstream ended Oct 2025) and Windows Server 2019 (mainstream ended Jan 2024).
  • Stale EventLogExpert_23.5.19.1256_x64.msix filename replaced with a <version> placeholder + a pointer to the latest release page.

Voice

Feature reference, not tutorial. Exact UI labels verbatim. No marketing voice. Why-only-when-non-obvious. One screenshot slot per page max (only EventLogExpert-CombinedView.png is wired up today; the rest are placeholders for follow-up).

Validation

  • Every UI label cited cross-checked against source (MenuBar.razor.cs, SettingsModal.razor, FilterPane.razor.cs, Reducers.cs, Effects.cs, LogTablePane.razor.cs, FilterService.cs, ResolvedEvent.cs, EventResolver.cs, *Command.cs).
  • Filterable-properties table in Filtering.md matches ResolvedEvent member-for-member with the Xml lazy-resolution caveat called out.
  • eventdbtool reference quotes the verbatim Description strings from each subcommand's GetCommand().
  • Markdown link sweep: every relative link in the new pages resolves.
  • git diff origin/main..HEAD -- . is docs + README only.

Closes #441.

Copilot AI review requested due to automatic review settings May 14, 2026 02:29
@jschick04 jschick04 requested a review from a team as a code owner May 14, 2026 02:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refreshes the README and documentation set from older tutorial-style pages into a current feature-reference structure aligned to the app’s menus, panes, modals, and CLI tooling.

Changes:

  • Replaces legacy docs with new topic pages for opening logs, viewing events, filters, settings, provider databases, keyboard/copy, and diagnostics.
  • Updates README feature list, quick start, dependency version, and supported OS guidance.
  • Removes obsolete setup/viewing/provider-database pages superseded by the new structure.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
README.md Updates feature summary and install guidance.
docs/Home.md Adds docs landing page and topic list.
docs/Opening-Logs.md Documents file/folder/live log opening and live behavior.
docs/Viewing-Events.md Documents tabs, event table, selection, and details pane.
docs/Filtering.md Expands filter pane, basic/date/advanced/cache/exclusion/highlight docs.
docs/Saved-Filters.md Documents filter cache and filter groups.
docs/Provider-Databases.md Replaces provider database reference and eventdbtool docs.
docs/Settings.md Documents settings modal options and database states.
docs/Keyboard-And-Copy.md Documents copy formats and keyboard/menu navigation.
docs/Updates-And-Diagnostics.md Documents Help menu update and diagnostics surfaces.
docs/FirstTimeSetup.md Removes superseded legacy setup page.
docs/ProviderDatabases.md Removes superseded legacy provider database page.
docs/Viewing.md Removes superseded legacy viewing page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/Settings.md
Comment thread docs/Saved-Filters.md
Comment thread docs/Saved-Filters.md
Comment thread docs/Updates-And-Diagnostics.md
Comment thread docs/Keyboard-And-Copy.md Outdated
Comment thread docs/Provider-Databases.md Outdated
Copilot AI review requested due to automatic review settings May 14, 2026 02:55
@jschick04 jschick04 force-pushed the jschick/docs-refresh branch from fdbeba1 to 22984b8 Compare May 14, 2026 02:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Comment thread docs/Keyboard-And-Copy.md Outdated
Comment thread docs/Provider-Databases.md Outdated
Comment thread docs/Settings.md Outdated
@jschick04 jschick04 force-pushed the jschick/docs-refresh branch from 22984b8 to 778bd34 Compare May 14, 2026 03:11
Copilot AI review requested due to automatic review settings May 14, 2026 03:14
@jschick04 jschick04 force-pushed the jschick/docs-refresh branch from 778bd34 to 3abd699 Compare May 14, 2026 03:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 16 changed files in this pull request and generated 4 comments.

Comment thread docs/Saved-Filters.md Outdated
Comment thread docs/Settings.md Outdated
Comment thread docs/Provider-Databases.md Outdated
Comment thread docs/Filtering.md Outdated
@jschick04 jschick04 force-pushed the jschick/docs-refresh branch from 3abd699 to 61c9f38 Compare May 14, 2026 04:27
Copilot AI review requested due to automatic review settings May 14, 2026 04:49
@jschick04 jschick04 force-pushed the jschick/docs-refresh branch from 61c9f38 to bf993fc Compare May 14, 2026 04:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 17 changed files in this pull request and generated 4 comments.

Comment thread docs/Settings.md Outdated
Comment thread docs/Settings.md
Comment thread docs/Provider-Databases.md
Comment thread docs/Updates-And-Diagnostics.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 17 changed files in this pull request and generated 3 comments.

Comment thread docs/Filtering.md Outdated
Comment thread docs/Keyboard-And-Copy.md Outdated
Comment thread docs/Saved-Filters.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 17 changed files in this pull request and generated no new comments.

@NikTilton NikTilton force-pushed the jschick/docs-refresh branch from 73f526f to 6be394d Compare May 14, 2026 17:56
@NikTilton NikTilton merged commit c48be55 into main May 14, 2026
6 checks passed
@NikTilton NikTilton deleted the jschick/docs-refresh branch May 14, 2026 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Readme.md lists wrong dependency

3 participants