<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>handleValidateDiataxisContent | DocuMCP API Documentation - v0.3.4</title><meta name="description" content="Documentation for DocuMCP API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">DocuMCP API Documentation - v0.3.4</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tools_validate-content.html">tools/validate-content</a></li><li><a href="" aria-current="page">handleValidateDiataxisContent</a></li></ul><h1>Function handleValidateDiataxisContent</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="handlevalidatediataxiscontent"><span class="tsd-kind-call-signature">handleValidateDiataxisContent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/tools_validate-content.ValidationResult.html" class="tsd-signature-type tsd-kind-interface">ValidationResult</a><span class="tsd-signature-symbol">></span><a href="#handlevalidatediataxiscontent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Validates Diataxis-compliant documentation content for accuracy, completeness, and compliance.</p>
<p>Performs comprehensive validation of documentation content including accuracy verification,
completeness assessment, compliance checking, and code example validation. Uses advanced
confidence scoring and risk assessment to provide detailed validation results with
actionable recommendations.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The validation parameters</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/tools_validate-content.ValidationResult.html" class="tsd-signature-type tsd-kind-interface">ValidationResult</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to comprehensive validation results</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When content path is inaccessible</p>
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When validation processing fails</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-0">// Comprehensive validation</span><br/><span class="hl-5">const</span><span class="hl-2"> </span><span class="hl-6">result</span><span class="hl-2"> = </span><span class="hl-7">await</span><span class="hl-2"> </span><span class="hl-1">handleValidateDiataxisContent</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-8">contentPath:</span><span class="hl-2"> </span><span class="hl-3">"./docs"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">validationType:</span><span class="hl-2"> </span><span class="hl-3">"all"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">includeCodeValidation:</span><span class="hl-2"> </span><span class="hl-5">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">confidence:</span><span class="hl-2"> </span><span class="hl-3">"moderate"</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-8">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">`Validation success: </span><span class="hl-5">${</span><span class="hl-8">result</span><span class="hl-10">.</span><span class="hl-8">success</span><span class="hl-5">}</span><span class="hl-3">`</span><span class="hl-2">);</span><br/><span class="hl-8">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">`Overall confidence: </span><span class="hl-5">${</span><span class="hl-8">result</span><span class="hl-10">.</span><span class="hl-8">confidence</span><span class="hl-10">.</span><span class="hl-8">overall</span><span class="hl-5">}</span><span class="hl-3">%`</span><span class="hl-2">);</span><br/><span class="hl-8">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">`Issues found: </span><span class="hl-5">${</span><span class="hl-8">result</span><span class="hl-10">.</span><span class="hl-8">issues</span><span class="hl-10">.</span><span class="hl-8">length</span><span class="hl-5">}</span><span class="hl-3">`</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Strict accuracy validation</span><br/><span class="hl-5">const</span><span class="hl-2"> </span><span class="hl-6">accuracy</span><span class="hl-2"> = </span><span class="hl-7">await</span><span class="hl-2"> </span><span class="hl-1">handleValidateDiataxisContent</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-8">contentPath:</span><span class="hl-2"> </span><span class="hl-3">"./docs"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">validationType:</span><span class="hl-2"> </span><span class="hl-3">"accuracy"</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">confidence:</span><span class="hl-2"> </span><span class="hl-3">"strict"</span><br/><span class="hl-2">});</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since">Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.0</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/tosin2013/documcp/blob/7623671d72f7fbc088dba9923f45eb01265278a1/src/tools/validate-content.ts#L1632">src/tools/validate-content.ts:1632</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">DocuMCP API Documentation - v0.3.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
