Skip to content

Commit 3fcc49c

Browse files
Coding-MeetCoding-Meet
committed
Deployed e5b9816 with MkDocs version: 1.6.1
1 parent 937877c commit 3fcc49c

9 files changed

Lines changed: 328 additions & 34 deletions

File tree

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎ai-agents/index.html‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -867,6 +867,78 @@
867867
</span>
868868
</a>
869869

870+
</li>
871+
872+
<li class="md-nav__item">
873+
<a href="#4-real-world-prompt-examples-for-developers-ai-agents" class="md-nav__link">
874+
<span class="md-ellipsis">
875+
876+
4. Real-World Prompt Examples for Developers &amp; AI Agents
877+
878+
</span>
879+
</a>
880+
881+
<nav class="md-nav" aria-label="4. Real-World Prompt Examples for Developers &amp; AI Agents">
882+
<ul class="md-nav__list">
883+
884+
<li class="md-nav__item">
885+
<a href="#example-1-exploring-unfamiliar-libraries-dsls" class="md-nav__link">
886+
<span class="md-ellipsis">
887+
888+
💡 Example 1: Exploring Unfamiliar Libraries &amp; DSLs
889+
890+
</span>
891+
</a>
892+
893+
</li>
894+
895+
<li class="md-nav__item">
896+
<a href="#example-2-scanning-bill-of-materials-bom" class="md-nav__link">
897+
<span class="md-ellipsis">
898+
899+
📦 Example 2: Scanning Bill of Materials (BOM)
900+
901+
</span>
902+
</a>
903+
904+
</li>
905+
906+
<li class="md-nav__item">
907+
<a href="#example-3-auditing-library-version-upgrades-breaking-changes" class="md-nav__link">
908+
<span class="md-ellipsis">
909+
910+
🔄 Example 3: Auditing Library Version Upgrades &amp; Breaking Changes
911+
912+
</span>
913+
</a>
914+
915+
</li>
916+
917+
<li class="md-nav__item">
918+
<a href="#example-4-exporting-local-source-code-context-for-ai-coding" class="md-nav__link">
919+
<span class="md-ellipsis">
920+
921+
⚡ Example 4: Exporting Local Source Code Context for AI Coding
922+
923+
</span>
924+
</a>
925+
926+
</li>
927+
928+
<li class="md-nav__item">
929+
<a href="#example-5-version-catalog-auto-discovery-zero-knowledge-scanning" class="md-nav__link">
930+
<span class="md-ellipsis">
931+
932+
🔍 Example 5: Version Catalog Auto-Discovery &amp; Zero-Knowledge Scanning
933+
934+
</span>
935+
</a>
936+
937+
</li>
938+
939+
</ul>
940+
</nav>
941+
870942
</li>
871943

872944
</ul>
@@ -961,6 +1033,78 @@
9611033
</span>
9621034
</a>
9631035

1036+
</li>
1037+
1038+
<li class="md-nav__item">
1039+
<a href="#4-real-world-prompt-examples-for-developers-ai-agents" class="md-nav__link">
1040+
<span class="md-ellipsis">
1041+
1042+
4. Real-World Prompt Examples for Developers &amp; AI Agents
1043+
1044+
</span>
1045+
</a>
1046+
1047+
<nav class="md-nav" aria-label="4. Real-World Prompt Examples for Developers &amp; AI Agents">
1048+
<ul class="md-nav__list">
1049+
1050+
<li class="md-nav__item">
1051+
<a href="#example-1-exploring-unfamiliar-libraries-dsls" class="md-nav__link">
1052+
<span class="md-ellipsis">
1053+
1054+
💡 Example 1: Exploring Unfamiliar Libraries &amp; DSLs
1055+
1056+
</span>
1057+
</a>
1058+
1059+
</li>
1060+
1061+
<li class="md-nav__item">
1062+
<a href="#example-2-scanning-bill-of-materials-bom" class="md-nav__link">
1063+
<span class="md-ellipsis">
1064+
1065+
📦 Example 2: Scanning Bill of Materials (BOM)
1066+
1067+
</span>
1068+
</a>
1069+
1070+
</li>
1071+
1072+
<li class="md-nav__item">
1073+
<a href="#example-3-auditing-library-version-upgrades-breaking-changes" class="md-nav__link">
1074+
<span class="md-ellipsis">
1075+
1076+
🔄 Example 3: Auditing Library Version Upgrades &amp; Breaking Changes
1077+
1078+
</span>
1079+
</a>
1080+
1081+
</li>
1082+
1083+
<li class="md-nav__item">
1084+
<a href="#example-4-exporting-local-source-code-context-for-ai-coding" class="md-nav__link">
1085+
<span class="md-ellipsis">
1086+
1087+
⚡ Example 4: Exporting Local Source Code Context for AI Coding
1088+
1089+
</span>
1090+
</a>
1091+
1092+
</li>
1093+
1094+
<li class="md-nav__item">
1095+
<a href="#example-5-version-catalog-auto-discovery-zero-knowledge-scanning" class="md-nav__link">
1096+
<span class="md-ellipsis">
1097+
1098+
🔍 Example 5: Version Catalog Auto-Discovery &amp; Zero-Knowledge Scanning
1099+
1100+
</span>
1101+
</a>
1102+
1103+
</li>
1104+
1105+
</ul>
1106+
</nav>
1107+
9641108
</li>
9651109

9661110
</ul>
@@ -1031,6 +1175,61 @@ <h2 id="3-feeding-source-code-context-to-llms">3. Feeding Source Code Context to
10311175
</span></code></pre></div></li>
10321176
</ol>
10331177
<p>This generates a compact, token-efficient split structure under <code>build/ai-context/</code>. You can feed this directory into Cursor, Claude, or Gemini workspace chats, giving them full knowledge of your classes, properties, constructors, methods, Javadocs/KDocs, file imports, and declaration line locations without wasting context tokens on massive raw file reads.</p>
1178+
<hr />
1179+
<h2 id="4-real-world-prompt-examples-for-developers-ai-agents">4. Real-World Prompt Examples for Developers &amp; AI Agents<a class="headerlink" href="#4-real-world-prompt-examples-for-developers-ai-agents" title="Link to this section">&para;</a></h2>
1180+
<p>Here are concrete examples of how you can prompt AI coding assistants (Cursor, Claude, Gemini, Copilot, etc.) to use <strong>Library Insight</strong> CLI commands automatically:</p>
1181+
<h3 id="example-1-exploring-unfamiliar-libraries-dsls">💡 Example 1: Exploring Unfamiliar Libraries &amp; DSLs<a class="headerlink" href="#example-1-exploring-unfamiliar-libraries-dsls" title="Link to this section">&para;</a></h3>
1182+
<blockquote>
1183+
<p><strong>Developer Prompt:</strong>
1184+
<em>"Use my <code>library-insight</code> CLI to scan <code>androidx.compose.foundation:foundation-layout:1.12.0</code>, search for <code>Grid</code>, explain its DSL structure, and create a working Jetpack Compose Grid layout example."</em></p>
1185+
</blockquote>
1186+
<p><strong>🤖 AI Agent Response Workflow:</strong>
1187+
1. Executes <code>library-insight scan androidx.compose.foundation:foundation-layout:1.12.0</code>
1188+
2. Executes <code>library-insight search Grid</code>
1189+
3. Executes <code>library-insight explain Grid --deep</code> to inspect top-level <code>GridKt</code>, receiver scopes (<code>GridScope</code>, <code>GridConfigurationScope</code>), and KDocs in 1 turn.
1190+
4. Generates 100% accurate, hallucination-free Kotlin Compose code matching the exact bytecode API signatures without needing web searches.</p>
1191+
<hr />
1192+
<h3 id="example-2-scanning-bill-of-materials-bom">📦 Example 2: Scanning Bill of Materials (BOM)<a class="headerlink" href="#example-2-scanning-bill-of-materials-bom" title="Link to this section">&para;</a></h3>
1193+
<blockquote>
1194+
<p><strong>Developer Prompt:</strong>
1195+
<em>"Scan <code>androidx.compose:compose-bom:2024.09.00</code> using <code>library-insight scan</code> and explain how <code>LazyVerticalGrid</code> and <code>StaggeredGridCells</code> work."</em></p>
1196+
</blockquote>
1197+
<p><strong>🤖 AI Agent Response Workflow:</strong>
1198+
1. Executes <code>library-insight scan androidx.compose:compose-bom:2024.09.00</code> (automatically parses POM XML and merges all 92 managed Compose libraries into one index).
1199+
2. Executes <code>library-insight explain LazyVerticalGrid --deep</code> to discover <code>LazyGridScope</code>, <code>LazyGridItemSpanScope</code>, and <code>GridItemSpan</code>.
1200+
3. Writes precise grid code using the exact version parameter signatures.</p>
1201+
<hr />
1202+
<h3 id="example-3-auditing-library-version-upgrades-breaking-changes">🔄 Example 3: Auditing Library Version Upgrades &amp; Breaking Changes<a class="headerlink" href="#example-3-auditing-library-version-upgrades-breaking-changes" title="Link to this section">&para;</a></h3>
1203+
<blockquote>
1204+
<p><strong>Developer Prompt:</strong>
1205+
<em>"Compare Retrofit versions <code>2.9.0</code> vs <code>2.11.0</code> using <code>library-insight diff</code> and tell me what APIs were added, removed, or deprecated."</em></p>
1206+
</blockquote>
1207+
<p><strong>🤖 AI Agent Response Workflow:</strong>
1208+
1. Executes <code>library-insight diff com.squareup.retrofit2:retrofit:2.9.0 com.squareup.retrofit2:retrofit:2.11.0</code>
1209+
2. Analyzes the generated JSON/Console diff report for signature modifications.
1210+
3. Provides a step-by-step migration advisor guide and deprecation checklist.</p>
1211+
<hr />
1212+
<h3 id="example-4-exporting-local-source-code-context-for-ai-coding">⚡ Example 4: Exporting Local Source Code Context for AI Coding<a class="headerlink" href="#example-4-exporting-local-source-code-context-for-ai-coding" title="Link to this section">&para;</a></h3>
1213+
<blockquote>
1214+
<p><strong>Developer Prompt:</strong>
1215+
<em>"Scan our local codebase <code>library-insight scan-source app/src/main</code>, run <code>library-insight ai-export</code>, and explain how <code>DashboardViewModel</code> interacts with our repository layer."</em></p>
1216+
</blockquote>
1217+
<p><strong>🤖 AI Agent Response Workflow:</strong>
1218+
1. Executes <code>library-insight scan-source app/src/main</code>
1219+
2. Executes <code>library-insight ai-export</code>
1220+
3. Inspects token-optimized markdown files in <code>build/ai-context/</code> to explain architecture and dependency flows with 0 token waste on raw code files.</p>
1221+
<hr />
1222+
<h3 id="example-5-version-catalog-auto-discovery-zero-knowledge-scanning">🔍 Example 5: Version Catalog Auto-Discovery &amp; Zero-Knowledge Scanning<a class="headerlink" href="#example-5-version-catalog-auto-discovery-zero-knowledge-scanning" title="Link to this section">&para;</a></h3>
1223+
<blockquote>
1224+
<p><strong>Developer Prompt:</strong>
1225+
<em>"I want to create a grid layout using Compose, but I don't know the exact library version. Find the library name and version from our project's version catalog (<code>gradle/libs.versions.toml</code>), scan it with <code>library-insight</code>, and generate the code for me."</em></p>
1226+
</blockquote>
1227+
<p><strong>🤖 AI Agent Response Workflow:</strong>
1228+
1. <strong>Version Catalog Inspection</strong>: The AI Agent inspects <code>gradle/libs.versions.toml</code> or <code>build.gradle.kts</code> to locate the project's declared library coordinates or BOM references (e.g. <code>androidx.compose.foundation:foundation-layout</code> or <code>compose-bom = "2024.09.00"</code>).
1229+
<em>(If not declared in the project, the agent runs <code>library-insight search-central "foundation-layout"</code> to query the latest release on Maven Central).</em>
1230+
2. <strong>Recommends &amp; Executes Scan</strong>: The agent recommends the exact command (<code>li scan androidx.compose.foundation:foundation-layout:1.12.0</code> or <code>li scan androidx.compose:compose-bom:2024.09.00</code>) and executes it immediately.
1231+
3. <strong>Explores &amp; Explains</strong>: Runs <code>li explain Grid --deep</code> to verify <code>GridScope</code>, <code>GridConfigurationScope</code>, and parameter signatures for that specific version.
1232+
4. <strong>Generates Precise Code</strong>: Delivers exact, version-matched Kotlin code tailored to the developer's project configuration!</p>
10341233

10351234

10361235

‎cli/explorer/index.html‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -677,10 +677,10 @@
677677
</li>
678678

679679
<li class="md-nav__item">
680-
<a href="#explain-explain-a-class" class="md-nav__link">
680+
<a href="#explain-explain-a-class-or-symbol" class="md-nav__link">
681681
<span class="md-ellipsis">
682682

683-
explain — Explain a Class
683+
explain — Explain a Class or Symbol
684684

685685
</span>
686686
</a>
@@ -956,10 +956,10 @@
956956
</li>
957957

958958
<li class="md-nav__item">
959-
<a href="#explain-explain-a-class" class="md-nav__link">
959+
<a href="#explain-explain-a-class-or-symbol" class="md-nav__link">
960960
<span class="md-ellipsis">
961961

962-
explain — Explain a Class
962+
explain — Explain a Class or Symbol
963963

964964
</span>
965965
</a>
@@ -1043,16 +1043,27 @@ <h2 id="search-search-symbols"><code>search</code> — Search Symbols<a class="h
10431043
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>--------------------------------------------------
10441044
</span></code></pre></div>
10451045
<hr />
1046-
<h2 id="explain-explain-a-class"><code>explain</code> — Explain a Class<a class="headerlink" href="#explain-explain-a-class" title="Link to this section">&para;</a></h2>
1047-
<p>Print detailed structural information (modifiers, superclass, constructors, properties, methods, Javadoc/KDoc, and nested usage guide examples extracted from README/Dokka markdown files) for a specific class.</p>
1046+
<h2 id="explain-explain-a-class-or-symbol"><code>explain</code> — Explain a Class or Symbol<a class="headerlink" href="#explain-explain-a-class-or-symbol" title="Link to this section">&para;</a></h2>
1047+
<p>Print detailed structural information (modifiers, superclass, constructors, properties, methods, Javadoc/KDoc, and nested usage guide examples extracted from README/Dokka markdown files) for a specific class or top-level symbol.</p>
10481048
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>library-insight<span class="w"> </span>explain<span class="w"> </span>HtmlBuilder
10491049
</span></code></pre></div>
1050+
<p><strong>Smart Resolution Capabilities:</strong></p>
1051+
<ul>
1052+
<li><strong>Kotlin Top-Level Function Resolution (<code>${name}Kt</code>)</strong>: Querying a top-level Kotlin function (e.g. <code>library-insight explain Grid</code>) automatically resolves to its Kotlin facade class (<code>GridKt</code>).</li>
1053+
<li><strong>Member Method &amp; Property Lookup</strong>: Querying a method or property directly (e.g. <code>library-insight explain gridItem</code>) automatically locates its declaring class (e.g. <code>GridScope</code>).</li>
1054+
<li><strong>Fuzzy Typo Suggestions</strong>: If a symbol is not found or has a typo, <code>explain</code> displays "Did you mean one of these?" with close matches.</li>
1055+
</ul>
10501056
<p><strong>Optional Parameters:</strong></p>
10511057
<ul>
1058+
<li><code>-d, --deep</code>: Recursively explain referenced parameter types, DSL receiver scopes, and return types in a single output.</li>
10521059
<li><code>--db &lt;file&gt;</code>: Index database JSON file path to read from (default: <code>build/library-insight-index.json</code>)</li>
10531060
</ul>
10541061
<p><strong>Example with options:</strong></p>
1055-
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>library-insight<span class="w"> </span>explain<span class="w"> </span>HtmlBuilder<span class="w"> </span>--db<span class="w"> </span>custom-index.json
1062+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Deep recursive DSL scope resolution</span>
1063+
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>library-insight<span class="w"> </span>explain<span class="w"> </span>Grid<span class="w"> </span>--deep
1064+
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
1065+
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1"># Custom database index</span>
1066+
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>library-insight<span class="w"> </span>explain<span class="w"> </span>HtmlBuilder<span class="w"> </span>--db<span class="w"> </span>custom-index.json
10561067
</span></code></pre></div>
10571068
<p><strong>Example output:</strong></p>
10581069
<div class="language-text highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>==================================================

0 commit comments

Comments
 (0)