Skip to content

Commit ca46688

Browse files
github-actions[bot]github-actions[bot]
committed
Deploy documentation: snapshot
1 parent 555de80 commit ca46688

281 files changed

Lines changed: 758 additions & 364 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎snapshot/advanced.html‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,11 +247,24 @@ <h2>Infinite Sessions</h2>
247247

248248
// Access the workspace where session state is persisted
249249
String workspace = session.getWorkspacePath();
250+
</code></pre><section><a id="Compaction_Events"></a>
251+
<h3>Compaction Events</h3>
252+
<p>When compaction occurs, the session emits events that you can listen for:</p>
253+
254+
<pre class="prettyprint"><code class="language-java">session.on(event -&gt; {
255+
if (event instanceof SessionCompactionStartEvent start) {
256+
System.out.println(&quot;Compaction started&quot;);
257+
} else if (event instanceof SessionCompactionCompleteEvent complete) {
258+
var data = complete.getData();
259+
System.out.println(&quot;Compaction completed - success: &quot; + data.isSuccess()
260+
+ &quot;, tokens removed: &quot; + data.getTokensRemoved());
261+
}
262+
});
250263
</code></pre>
251264
<p>For short conversations, disable to avoid overhead:</p>
252265

253266
<pre class="prettyprint"><code class="language-java">new InfiniteSessionConfig().setEnabled(false)
254-
</code></pre><hr /></section><section><a id="MCP_Servers"></a>
267+
</code></pre><hr /></section></section><section><a id="MCP_Servers"></a>
255268
<h2>MCP Servers</h2>
256269
<p>Extend the AI with external tools via the Model Context Protocol.</p>
257270

@@ -267,7 +280,46 @@ <h2>MCP Servers</h2>
267280
.setMcpServers(Map.of(&quot;filesystem&quot;, server))
268281
).get();
269282
</code></pre>
270-
<p>&#x1f4d6; <strong><a href="mcp.html">Full MCP documentation &#x2192;</a></strong> for local/remote servers and all options.</p><hr /></section><section><a id="Permission_Handling"></a>
283+
<p>&#x1f4d6; <strong><a href="mcp.html">Full MCP documentation &#x2192;</a></strong> for local/remote servers and all options.</p><hr /></section><section><a id="Skills_Configuration"></a>
284+
<h2>Skills Configuration</h2>
285+
<p>Load custom skills from directories to extend the AI's capabilities with domain-specific knowledge.</p><section><a id="Loading_Skills"></a>
286+
<h3>Loading Skills</h3>
287+
<p>Skills are loaded from <code>SKILL.md</code> files in subdirectories of the specified skill directories:</p>
288+
289+
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
290+
new SessionConfig()
291+
.setSkillDirectories(List.of(&quot;/path/to/skills&quot;))
292+
).get();
293+
</code></pre>
294+
<p>Each skill subdirectory should contain a <code>SKILL.md</code> file with YAML frontmatter:</p>
295+
296+
<pre class="prettyprint"><code class="language-markdown">---
297+
name: my-skill
298+
description: A skill that provides domain-specific knowledge
299+
---
300+
301+
# Skill Instructions
302+
303+
Your skill instructions go here...
304+
</code></pre></section><section><a id="Disabling_Skills"></a>
305+
<h3>Disabling Skills</h3>
306+
<p>Disable specific skills by name:</p>
307+
308+
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
309+
new SessionConfig()
310+
.setSkillDirectories(List.of(&quot;/path/to/skills&quot;))
311+
.setDisabledSkills(List.of(&quot;my-skill&quot;))
312+
).get();
313+
</code></pre><hr /></section></section><section><a id="Custom_Configuration_Directory"></a>
314+
<h2>Custom Configuration Directory</h2>
315+
<p>Use a custom configuration directory for session settings:</p>
316+
317+
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
318+
new SessionConfig()
319+
.setConfigDir(&quot;/path/to/custom/config&quot;)
320+
).get();
321+
</code></pre>
322+
<p>This is useful when you need to isolate session configuration or use different settings for different environments.</p><hr /></section><section><a id="Permission_Handling"></a>
271323
<h2>Permission Handling</h2>
272324
<p>Approve or deny permission requests from the AI.</p>
273325

‎snapshot/apidocs/allclasses-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Thu Jan 29 15:53:51 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Thu Jan 29 16:26:39 UTC 2026 -->
55
<title>All Classes and Interfaces (GitHub Copilot Community SDK :: Java 1.0.5-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/allpackages-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Thu Jan 29 15:53:51 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Thu Jan 29 16:26:39 UTC 2026 -->
55
<title>All Packages (GitHub Copilot Community SDK :: Java 1.0.5-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/ConnectionState.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Thu Jan 29 15:53:51 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Thu Jan 29 16:26:39 UTC 2026 -->
55
<title>ConnectionState (GitHub Copilot Community SDK :: Java 1.0.5-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

‎snapshot/apidocs/com/github/copilot/sdk/CopilotClient.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Thu Jan 29 15:53:51 UTC 2026 -->
4+
<!-- Generated by javadoc (17) on Thu Jan 29 16:26:39 UTC 2026 -->
55
<title>CopilotClient (GitHub Copilot Community SDK :: Java 1.0.5-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

0 commit comments

Comments
 (0)