Refresh docs and README for current product surface#522
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.
fdbeba1 to
22984b8
Compare
22984b8 to
778bd34
Compare
778bd34 to
3abd699
Compare
3abd699 to
61c9f38
Compare
61c9f38 to
bf993fc
Compare
bf993fc to
7047810
Compare
7047810 to
73f526f
Compare
NikTilton
approved these changes
May 14, 2026
…--skip-providers-in-file verbatim, neutralize broken image placeholders
73f526f to
6be394d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refresh
docs/andREADME.mdfor the current product surface. The previous docs were last touched in June 2023;mainhas 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.md—Filemenu (File / Folder / Live), drag-and-drop, command-line.evtxopens, 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 fromResolvedEvent), Cached, Date, Exclusion semantics, highlighting.Saved-Filters.md— Filter cache (Favorites + Recent) and named filter groups; per-group and bulk import / export;Apply Filtersadd-and-dedupe semantics.Provider-Databases.md— Why DBs exist, resolution order (MTA → enabled DBs → local fallback),Settingslifecycle states, fulleventdbtoolsubcommand reference (show/create/merge/diff/upgrade) with verbatimDescriptionstrings.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 rebindsCtrl+C,Ctrl+Htoggle.Updates-And-Diagnostics.md—Helpmenu: Docs, Submit an Issue, Check for Updates, Release Notes, View Logs.Removed (legacy 2023 pages, replaced)
docs/FirstTimeSetup.mddocs/ProviderDatabases.mddocs/Viewing.mdREADME
Ctrl+Cmodes, themes, on-demand XML, in-app Release Notes + Debug Log viewer, opt-in pre-release update channel) alongside the originals..appinstaller-first.Microsoft.WindowsAppRuntimeexample bumped1.2→1.7(matches the current appxmanifest dependency).EventLogExpert_23.5.19.1256_x64.msixfilename 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.pngis wired up today; the rest are placeholders for follow-up).Validation
MenuBar.razor.cs,SettingsModal.razor,FilterPane.razor.cs,Reducers.cs,Effects.cs,LogTablePane.razor.cs,FilterService.cs,ResolvedEvent.cs,EventResolver.cs,*Command.cs).Filtering.mdmatchesResolvedEventmember-for-member with theXmllazy-resolution caveat called out.eventdbtoolreference quotes the verbatimDescriptionstrings from each subcommand'sGetCommand().git diff origin/main..HEAD -- .is docs + README only.Closes #441.