Skip to content

Commit 3c0cbb6

Browse files
committed
update some broken links for the docs
1 parent 4326358 commit 3c0cbb6

12 files changed

Lines changed: 14 additions & 14 deletions

docs/sdk/documents/01-getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
observer.observe(document.documentElement, { attributes: true });
2424
</script>
2525
<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">SmythOS SDK</a><div id="tsd-toolbar-links"><a href="https://discord.gg/smythos">Discord</a><a href="https://smythos.github.io/sre/core/">Core</a><a href="https://smythos.github.io/sre/sdk/">SDK</a><a href="https://smythos.github.io/sre/cli/">CLI</a><a href="https://github.com/smythos/sre">GitHub</a></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="" aria-current="page">01-getting-started</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="getting-started" class="tsd-anchor-link">Getting Started<a href="#getting-started" 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></h1><p>Welcome to the SmythOS SDK! This guide will walk you through creating your very first AI agent. We'll build an agent that can fetch real-time cryptocurrency prices from an API.</p>
26-
<p>The code in this guide is a more detailed version of the script found in <a href="../../examples/01-agent-code-skill/01-prompting.ts"><code>examples/01-agent-code-skill/01-prompting.ts</code></a>.</p>
26+
<p>The code in this guide is a more detailed version of the script found in <a href="https://github.com/SmythOS/sre/blob/main/examples/01-agent-code-skill/01-prompting.ts"><code>examples/01-agent-code-skill/01-prompting.ts</code></a>.</p>
2727
<h2 id="1-installation" class="tsd-anchor-link">1. Installation<a href="#1-installation" 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></h2><h3 id="method-1-using-the-cli-recommended" class="tsd-anchor-link">Method 1: Using the CLI (Recommended)<a href="#method-1-using-the-cli-recommended" 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></h3><p>The easiest way to get started is by using the SmythOS CLI to scaffold a new project:</p>
2828
<pre><code class="bash"><span class="hl-4"># Install the CLI globally</span><br/><span class="hl-5">npm</span><span class="hl-1"> </span><span class="hl-3">i</span><span class="hl-1"> </span><span class="hl-6">-g</span><span class="hl-1"> </span><span class="hl-3">@smythos/cli</span><br/><br/><span class="hl-4"># Create a new project</span><br/><span class="hl-5">sre</span><span class="hl-1"> </span><span class="hl-3">create</span><span class="hl-1"> </span><span class="hl-3">&quot;My First Agent&quot;</span>
2929
</code><button type="button">Copy</button></pre>

docs/sdk/documents/03-streaming.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
observer.observe(document.documentElement, { attributes: true });
2424
</script>
2525
<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">SmythOS SDK</a><div id="tsd-toolbar-links"><a href="https://discord.gg/smythos">Discord</a><a href="https://smythos.github.io/sre/core/">Core</a><a href="https://smythos.github.io/sre/sdk/">SDK</a><a href="https://smythos.github.io/sre/cli/">CLI</a><a href="https://github.com/smythos/sre">GitHub</a></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="" aria-current="page">03-streaming</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="streaming-responses" class="tsd-anchor-link">Streaming Responses<a href="#streaming-responses" 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></h1><p>For building dynamic, real-time applications, waiting for an agent's full response can lead to a slow user experience. The SmythOS SDK solves this with streaming, allowing you to process the agent's output token-by-token as it's generated. This is perfect for creating &quot;typewriter&quot; effects in UIs and providing immediate feedback to the user.</p>
26-
<p>The script in <a href="../../examples/01-agent-code-skill/02-streaming.ts"><code>examples/01-agent-code-skill/02-streaming.ts</code></a> provides a complete, runnable example of the concepts below.</p>
26+
<p>The script in <a href="https://github.com/SmythOS/sre/blob/main/examples/01-agent-code-skill/02-streaming.ts"><code>examples/01-agent-code-skill/02-streaming.ts</code></a> provides a complete, runnable example of the concepts below.</p>
2727
<h2 id="how-streaming-works" class="tsd-anchor-link">How Streaming Works<a href="#how-streaming-works" 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></h2><p>Instead of <code>await</code>-ing the <code>agent.prompt()</code> call directly, you chain the <code>.stream()</code> method. This doesn't return the final string response. Instead, it returns a standard Node.js <code>EventEmitter</code> that you can subscribe to.</p>
2828
<p>This <code>EventEmitter</code> will emit different events during the lifecycle of the agent's response generation, as defined in the <code>TLLMEvent</code> enum.</p>
2929
<h2 id="basic-streaming-content-and-end-events" class="tsd-anchor-link">Basic Streaming: Content and End Events<a href="#basic-streaming-content-and-end-events" 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></h2><p>The most common use case is to listen for content chunks and the end of the stream.</p>

0 commit comments

Comments
 (0)