Skip to content

docs: sync README to 3.0.0 facts + note install-log cleanup#1130

Merged
erikdarlingdata merged 1 commit into
devfrom
fix/3.0.0-readme-sync
Jun 16, 2026
Merged

docs: sync README to 3.0.0 facts + note install-log cleanup#1130
erikdarlingdata merged 1 commit into
devfrom
fix/3.0.0-readme-sync

Conversation

@erikdarlingdata

Copy link
Copy Markdown
Owner

Summary

README sync for the v3.0.0 release — corrects stale counts an external audit flagged and documents the new 3.0 features. All changes verified against the codebase before editing.

README edits (surgical, no EOL churn)

  1. Download table "What it does": 30 → 33 T-SQL collectors
  2. Highlights MCP line: 51-63 → 55-66 read-only tools
  3. Edition comparison Collectors row: 32 / 24 → 33 / 25
  4. Edition comparison MCP row: 63 / 52 → 66 / 55 tools
  5. Full Overview tab row: added recommendations alongside critical issues
  6. Lite tabs table: added a Recommendations row (Lite has a top-level Recommendations tab in 3.0)
  7. Alert Types: added Volume free space (10% or 5 GB free; never fires on Azure SQL DB) and Failed agent job (60-minute lookback; skipped on Azure SQL DB) rows
  8. MCP intro: exposes 63 / 52 → 66 / 55 tools
  9. MCP tools table: added Object/Index Stats row (get_table_index_sizes, get_index_usage, get_object_locking — registered in both apps); removed the erroneous Lite-only * markers from the Diagnostic Analysis row (those six tools are registered in the Dashboard too)
  10. Folder structure: 58 → 59 SQL installation scripts
  11. "What You Get": added a bullet for the headline 3.0 Recommendations / Apply Fix (advise-and-act) engine with informed-consent destructive fixes
  12. CI badge: repointed from non-existent ci.yml to build.yml so the badge renders

Verification

  • install/ confirmed at 59 .sql scripts
  • The 3 object-stats MCP tools and all 6 diagnostic-analysis tools confirmed registered in both Dashboard and Lite
  • Volume-free-space (LowDiskThresholdPercent=10, LowDiskThresholdGb=5) and failed-job (FailedJobLookbackMinutes=60) defaults confirmed in source
  • build.yml exists; ci.yml does not

Install-log cleanup

The PerformanceMonitor_Install_*.txt test-run logs are already untracked and already covered by .gitignore (line 45). Nothing to git rm and no .gitignore change needed — the git-side cleanup was already in place. (75 such files exist in the working tree but are ignored.)

git diff --stat: README.md | 24 +++--- (15 insertions, 9 deletions)

🤖 Generated with Claude Code

Correct stale 3.0.0 counts and document new 3.0 features in README:
- Collector counts: download table 30->33, edition comparison 32/24->33/25
- MCP tool counts: 51-63->55-66 (highlights), 63/52->66/55 (comparison + MCP intro)
- install/ script count 58->59 (folder structure)
- Add "What You Get" bullet for the Recommendations / Apply Fix
  (advise-and-act) engine with informed-consent destructive fixes
- Full Overview tab: add "recommendations"; add Lite "Recommendations" tab row
- Alert Types: add Volume Free Space (10% or 5 GB; never on Azure SQL DB)
  and Failed Agent Job (60-min lookback; skipped on Azure SQL DB) rows
- MCP tools table: add Object/Index Stats row (get_table_index_sizes,
  get_index_usage, get_object_locking; registered in both apps); remove
  erroneous Lite-only markers from the Diagnostic Analysis row (those
  six tools are registered in the Dashboard too)
- CI badge: point at build.yml (ci.yml does not exist) so it renders

Install-log cleanup: PerformanceMonitor_Install_*.txt logs are already
untracked and covered by .gitignore (line 45); no git changes needed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@erikdarlingdata erikdarlingdata merged commit 56552b4 into dev Jun 16, 2026
2 checks passed
@erikdarlingdata erikdarlingdata deleted the fix/3.0.0-readme-sync branch June 16, 2026 20:26
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.

1 participant