Skip to content

docs: fix version mismatches, broken links, and add .editorconfig#246

Merged
jongio merged 1 commit into
mainfrom
patrol/docs-config-fixes
May 18, 2026
Merged

docs: fix version mismatches, broken links, and add .editorconfig#246
jongio merged 1 commit into
mainfrom
patrol/docs-config-fixes

Conversation

@jongio
Copy link
Copy Markdown
Owner

@jongio jongio commented May 18, 2026

This PR addresses multiple documentation and configuration issues:

Changes

  1. Go version mismatch - Updated README.md badge and CONTRIBUTING.md prerequisites from 1.26.1 to 1.26.3 to match go.mod and CI workflows.

  2. Outdated SECURITY.md - Updated supported versions table from 0.1.x to 0.14.x (current release), added unsupported versions row.

  3. Dashboard setup uses npm instead of pnpm - Fixed CONTRIBUTING.md to reference pnpm for dashboard dependency installation, matching the project's actual package manager (pnpm-lock.yaml, CI workflows).

  4. Broken documentation link - Fixed the Azure Logs feature guide link in cli/README.md to use explicit relative path (./docs/features/azure-logs.md).

  5. Missing .editorconfig - Added .editorconfig for cross-IDE formatting consistency (Go: tabs, TS/JS/JSON/YAML: 2 spaces, LF line endings, trim trailing whitespace).

Fixes #222
Fixes #223
Fixes #226
Fixes #208
Fixes #219

- Update Go version from 1.26.1 to 1.26.3 in README.md and CONTRIBUTING.md to match go.mod/CI
- Update SECURITY.md supported versions table from 0.1.x to 0.14.x (current release)
- Fix CONTRIBUTING.md to use pnpm instead of npm for dashboard setup
- Fix broken documentation link in cli/README.md for Azure Logs feature guide
- Add .editorconfig for cross-IDE formatting consistency

Fixes #222
Fixes #223
Fixes #226
Fixes #208
Fixes #219
@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.14%. Comparing base (8735f89) to head (8f4fb27).
⚠️ Report is 16 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #246      +/-   ##
==========================================
+ Coverage   57.06%   57.14%   +0.08%     
==========================================
  Files         158      158              
  Lines       22736    22736              
==========================================
+ Hits        12974    12993      +19     
+ Misses       8963     8942      -21     
- Partials      799      801       +2     
Flag Coverage Δ
unittests 57.14% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jongio jongio merged commit 8f23582 into main May 18, 2026
14 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment