Skip to content

docs: fix broken SearchCriteria reference link#77

Merged
zircote merged 1 commit intomainfrom
docs/fix-search-criteria-link-62f3053bdf2299c4
Feb 18, 2026
Merged

docs: fix broken SearchCriteria reference link#77
zircote merged 1 commit intomainfrom
docs/fix-search-criteria-link-62f3053bdf2299c4

Conversation

@zircote
Copy link
Owner

@zircote zircote commented Feb 17, 2026

Summary

Fixed a broken internal documentation link in the "How to Filter Search Results" guide.

Changes

  • File: docs/how-to/FILTER-SEARCH-RESULTS.md
  • Issue: Referenced non-existent ../reference/SEARCH-CRITERIA.md
  • Fix: Updated link to ../reference/LIBRARY-API.md#searchcriteria

Why This Matters

The SearchCriteria documentation exists in LIBRARY-API.md (lines 305-369) with comprehensive coverage of:

  • Construction methods
  • All builder methods
  • Field reference with JSON mappings
  • Complete examples

The broken link prevented users from accessing this complete reference material.

Verification

  • ✅ Target file docs/reference/LIBRARY-API.md#searchcriteria exists
  • ✅ Section anchor is correct
  • ✅ Link follows relative path conventions
  • ✅ No other references to non-existent SEARCH-CRITERIA.md found

Documentation Quality

This repository has excellent documentation (17,014 lines across 60+ files) following the Diataxis framework. This was the only broken link found during comprehensive documentation audit.

AI generated by Update Docs

The FILTER-SEARCH-RESULTS.md file referenced a non-existent
SEARCH-CRITERIA.md document. The SearchCriteria documentation
exists in LIBRARY-API.md with comprehensive coverage of
construction, builder methods, fields, and examples.

Updated the link to point to the correct section anchor.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@zircote zircote added automation documentation Improvements or additions to documentation labels Feb 17, 2026
@github-actions
Copy link
Contributor

Benchmark Results

No benchmarks configured. Add benchmarks to benches/ directory.

Full results available in CI artifacts.

@codecov
Copy link

codecov bot commented Feb 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.83%. Comparing base (cb8adeb) to head (5700fb6).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files           9        9           
  Lines        6499     6499           
=======================================
  Hits         6228     6228           
  Misses        271      271           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Contributor

Code Coverage Report

Overall Coverage: 0%

Summary

Filename                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
client.rs                        1444                67    95.36%         118                13    88.98%         923                35    96.21%           0                 0         -
format.rs                        2172                 3    99.86%         132                 1    99.24%        1292                 1    99.92%           0                 0         -
main.rs                           326               241    26.07%          14                 8    42.86%         225               168    25.33%           0                 0         -
mcp/analytics.rs                  408                 2    99.51%          24                 0   100.00%         331                 0   100.00%           0                 0         -
mcp/mod.rs                        144                55    61.81%          23                15    34.78%         128                65    49.22%           0                 0         -
mcp/prompts.rs                   1908                33    98.27%         126                 6    95.24%        1043                12    98.85%           0                 0         -
mcp/resources.rs                 1317                20    98.48%          93                 1    98.92%         865                 6    99.31%           0                 0         -
mcp/tools.rs                     2146                90    95.81%         116                18    84.48%        1333                47    96.47%           0                 0         -
models.rs                        1079                31    97.13%          78                10    87.18%         762                14    98.16%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                           10944               542    95.05%         724                72    90.06%        6902               348    94.96%           0                 0         -

Full HTML report available in CI artifacts.

@zircote zircote marked this pull request as ready for review February 18, 2026 01:01
Copilot AI review requested due to automatic review settings February 18, 2026 01:01
@zircote zircote merged commit 467c0f0 into main Feb 18, 2026
37 checks passed
@zircote zircote deleted the docs/fix-search-criteria-link-62f3053bdf2299c4 branch February 18, 2026 01:01
Copy link

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

Fixes a broken internal documentation link in the “How to Filter Search Results” guide by pointing the SearchCriteria reference to the correct section in the library API reference.

Changes:

  • Replaced the dead link to ../reference/SEARCH-CRITERIA.md with ../reference/LIBRARY-API.md#searchcriteria.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants