Skip to content

Commit b94e419

Browse files
AndrewClements84AndrewClements84
committed
deploy: b260429 
0 parents  commit b94e419

27 files changed

Lines changed: 3670 additions & 0 deletions

‎.nojekyll‎

Whitespace-only changes.

‎docs/changelog.html‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>&#129534; Changelog | PromptStream.AI Documentation </title>
9+
<meta name="viewport" content="width=device-width">
10+
<meta name="title" content="&#129534; Changelog | PromptStream.AI Documentation ">
11+
12+
13+
<link rel="shortcut icon" href="../favicon.ico">
14+
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
15+
<link rel="stylesheet" href="../styles/docfx.css">
16+
<link rel="stylesheet" href="../styles/main.css">
17+
<meta property="docfx:navrel" content="">
18+
<meta property="docfx:tocrel" content="">
19+
20+
21+
22+
</head>
23+
<body data-spy="scroll" data-target="#affix" data-offset="120">
24+
<div id="wrapper">
25+
<header>
26+
27+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
28+
<div class="container">
29+
<div class="navbar-header">
30+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
31+
<span class="sr-only">Toggle navigation</span>
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</button>
36+
37+
<a class="navbar-brand" href="../index.html">
38+
<img id="logo" class="svg" src="../logo.svg" alt="">
39+
</a>
40+
</div>
41+
<div class="collapse navbar-collapse" id="navbar">
42+
<form class="navbar-form navbar-right" role="search" id="search">
43+
<div class="form-group">
44+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
45+
</div>
46+
</form>
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<div class="subnav navbar navbar-default">
52+
<div class="container hide-when-search" id="breadcrumb">
53+
<ul class="breadcrumb">
54+
<li></li>
55+
</ul>
56+
</div>
57+
</div>
58+
</header>
59+
<div role="main" class="container body-content hide-when-search">
60+
<div class="article row grid">
61+
<div class="col-md-10">
62+
<article class="content wrap" id="_content" data-uid="">
63+
<h1 id="-changelog">🧾 Changelog</h1>
64+
65+
<h2 id="v070">v0.7.0</h2>
66+
<ul>
67+
<li>Added <code>PromptStream.AI.CLI</code> with <code>build</code>, <code>validate</code>, <code>generate</code>, and <code>context</code> commands.</li>
68+
<li>Added full test suite (100% code coverage).</li>
69+
<li>Introduced DI-ready <code>TokenFlowModelClient</code>.</li>
70+
<li>Polished prompt validation and async handling.</li>
71+
</ul>
72+
<h2 id="v06x">v0.6.x</h2>
73+
<ul>
74+
<li>Added <code>PromptStreamService</code> orchestration layer.</li>
75+
<li>Introduced <code>PromptValidator</code> and <code>PromptContextManager</code>.</li>
76+
</ul>
77+
78+
</article>
79+
</div>
80+
81+
<div class="hidden-sm col-md-2" role="complementary">
82+
<div class="sideaffix">
83+
<div class="contribution">
84+
<ul class="nav">
85+
<li>
86+
<a href="https://github.com/AndrewClements84/PromptStream.AI/blob/master/docs/changelog.md/#L1" class="contribution-link">Edit this page</a>
87+
</li>
88+
</ul>
89+
</div>
90+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
91+
<h5>In this article</h5>
92+
<div></div>
93+
</nav>
94+
</div>
95+
</div>
96+
</div>
97+
</div>
98+
99+
<footer>
100+
<div class="grad-bottom"></div>
101+
<div class="footer">
102+
<div class="container">
103+
<span class="pull-right">
104+
<a href="#top">Back to top</a>
105+
</span>
106+
© 2025 AndrewClements84 · Built with DocFX
107+
108+
</div>
109+
</div>
110+
</footer>
111+
</div>
112+
113+
<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
114+
<script type="text/javascript" src="../styles/docfx.js"></script>
115+
<script type="text/javascript" src="../styles/main.js"></script>
116+
</body>
117+
</html>

‎docs/cli-usage.html‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>&#128187; CLI Usage Guide | PromptStream.AI Documentation </title>
9+
<meta name="viewport" content="width=device-width">
10+
<meta name="title" content="&#128187; CLI Usage Guide | PromptStream.AI Documentation ">
11+
12+
13+
<link rel="shortcut icon" href="../favicon.ico">
14+
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
15+
<link rel="stylesheet" href="../styles/docfx.css">
16+
<link rel="stylesheet" href="../styles/main.css">
17+
<meta property="docfx:navrel" content="">
18+
<meta property="docfx:tocrel" content="">
19+
20+
21+
22+
</head>
23+
<body data-spy="scroll" data-target="#affix" data-offset="120">
24+
<div id="wrapper">
25+
<header>
26+
27+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
28+
<div class="container">
29+
<div class="navbar-header">
30+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
31+
<span class="sr-only">Toggle navigation</span>
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</button>
36+
37+
<a class="navbar-brand" href="../index.html">
38+
<img id="logo" class="svg" src="../logo.svg" alt="">
39+
</a>
40+
</div>
41+
<div class="collapse navbar-collapse" id="navbar">
42+
<form class="navbar-form navbar-right" role="search" id="search">
43+
<div class="form-group">
44+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
45+
</div>
46+
</form>
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<div class="subnav navbar navbar-default">
52+
<div class="container hide-when-search" id="breadcrumb">
53+
<ul class="breadcrumb">
54+
<li></li>
55+
</ul>
56+
</div>
57+
</div>
58+
</header>
59+
<div role="main" class="container body-content hide-when-search">
60+
<div class="article row grid">
61+
<div class="col-md-10">
62+
<article class="content wrap" id="_content" data-uid="">
63+
<h1 id="-cli-usage-guide">💻 CLI Usage Guide</h1>
64+
65+
<p>The <strong>PromptStream.AI CLI</strong> allows you to quickly build, validate, and generate prompts directly from the terminal.</p>
66+
<hr>
67+
<h2 id="-build">🧱 Build</h2>
68+
<p>Render a prompt template with variables.</p>
69+
<pre><code class="lang-bash">promptstream build --template &quot;./examples/welcome.txt&quot; --var name=Andrew
70+
</code></pre>
71+
<p>Outputs:</p>
72+
<pre><code>✅ Prompt built successfully:
73+
Hello Andrew, welcome to PromptStream.AI!
74+
</code></pre>
75+
<hr>
76+
<h2 id="-validate">✅ Validate</h2>
77+
<p>Validate a prompt for completeness and token safety.</p>
78+
<pre><code class="lang-bash">promptstream validate --template &quot;./examples/summary.txt&quot; --var topic=AI
79+
</code></pre>
80+
<p>Outputs:</p>
81+
<pre><code>✅ Valid prompt (37 tokens)
82+
</code></pre>
83+
<hr>
84+
<h2 id="-generate">🤖 Generate</h2>
85+
<p>Build, validate, and generate a model reply.</p>
86+
<pre><code class="lang-bash">promptstream generate --template &quot;./examples/summary.txt&quot; --var topic=AI
87+
</code></pre>
88+
<p>Outputs:</p>
89+
<pre><code>✅ Generation complete:
90+
[TokenFlow gpt-4o-mini] processed 32 tokens.
91+
</code></pre>
92+
<hr>
93+
<h2 id="-context">💬 Context</h2>
94+
<p>Inspect or manage conversation history.</p>
95+
<pre><code class="lang-bash">promptstream context --load context.json --summarize
96+
promptstream context --clear --save context.json
97+
</code></pre>
98+
<p>Outputs:</p>
99+
<pre><code>📂 Loaded 4 messages from context.json
100+
Summary: 4 messages (user, assistant)
101+
</code></pre>
102+
<hr>
103+
<h3 id="-tips">🌈 Tips</h3>
104+
<ul>
105+
<li>Use <code>--template</code> for inline text or a file path.</li>
106+
<li>Chain variables with multiple <code>--var</code> arguments.</li>
107+
<li>Combine <code>--context</code> and <code>--save</code> to preserve conversation state.</li>
108+
</ul>
109+
110+
</article>
111+
</div>
112+
113+
<div class="hidden-sm col-md-2" role="complementary">
114+
<div class="sideaffix">
115+
<div class="contribution">
116+
<ul class="nav">
117+
<li>
118+
<a href="https://github.com/AndrewClements84/PromptStream.AI/blob/master/docs/cli-usage.md/#L1" class="contribution-link">Edit this page</a>
119+
</li>
120+
</ul>
121+
</div>
122+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
123+
<h5>In this article</h5>
124+
<div></div>
125+
</nav>
126+
</div>
127+
</div>
128+
</div>
129+
</div>
130+
131+
<footer>
132+
<div class="grad-bottom"></div>
133+
<div class="footer">
134+
<div class="container">
135+
<span class="pull-right">
136+
<a href="#top">Back to top</a>
137+
</span>
138+
© 2025 AndrewClements84 · Built with DocFX
139+
140+
</div>
141+
</div>
142+
</footer>
143+
</div>
144+
145+
<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
146+
<script type="text/javascript" src="../styles/docfx.js"></script>
147+
<script type="text/javascript" src="../styles/main.js"></script>
148+
</body>
149+
</html>

‎docs/contributing.html‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>&#129513; Contributing | PromptStream.AI Documentation </title>
9+
<meta name="viewport" content="width=device-width">
10+
<meta name="title" content="&#129513; Contributing | PromptStream.AI Documentation ">
11+
12+
13+
<link rel="shortcut icon" href="../favicon.ico">
14+
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
15+
<link rel="stylesheet" href="../styles/docfx.css">
16+
<link rel="stylesheet" href="../styles/main.css">
17+
<meta property="docfx:navrel" content="">
18+
<meta property="docfx:tocrel" content="">
19+
20+
21+
22+
</head>
23+
<body data-spy="scroll" data-target="#affix" data-offset="120">
24+
<div id="wrapper">
25+
<header>
26+
27+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
28+
<div class="container">
29+
<div class="navbar-header">
30+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
31+
<span class="sr-only">Toggle navigation</span>
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</button>
36+
37+
<a class="navbar-brand" href="../index.html">
38+
<img id="logo" class="svg" src="../logo.svg" alt="">
39+
</a>
40+
</div>
41+
<div class="collapse navbar-collapse" id="navbar">
42+
<form class="navbar-form navbar-right" role="search" id="search">
43+
<div class="form-group">
44+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
45+
</div>
46+
</form>
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<div class="subnav navbar navbar-default">
52+
<div class="container hide-when-search" id="breadcrumb">
53+
<ul class="breadcrumb">
54+
<li></li>
55+
</ul>
56+
</div>
57+
</div>
58+
</header>
59+
<div role="main" class="container body-content hide-when-search">
60+
<div class="article row grid">
61+
<div class="col-md-10">
62+
<article class="content wrap" id="_content" data-uid="">
63+
<h1 id="-contributing">🧩 Contributing</h1>
64+
65+
<p>Contributions are welcome!<br>
66+
Before submitting a PR, please ensure the following:</p>
67+
<ul>
68+
<li>✅ All tests pass (<code>dotnet test --collect:&quot;XPlat Code Coverage&quot;</code>).</li>
69+
<li>🧪 Code coverage ≥ 95%.</li>
70+
<li>🧾 XML doc comments for public methods.</li>
71+
<li>💬 New CLI commands include <code>--help</code> descriptions.</li>
72+
<li>🔍 Run <code>docfx build</code> locally to verify documentation.</li>
73+
</ul>
74+
<hr>
75+
<h2 id="build-docs-locally">Build Docs Locally</h2>
76+
<pre><code class="lang-bash">docfx build
77+
docfx serve site
78+
</code></pre>
79+
<p>Then visit:<br>
80+
👉 http://localhost:8080</p>
81+
82+
</article>
83+
</div>
84+
85+
<div class="hidden-sm col-md-2" role="complementary">
86+
<div class="sideaffix">
87+
<div class="contribution">
88+
<ul class="nav">
89+
<li>
90+
<a href="https://github.com/AndrewClements84/PromptStream.AI/blob/master/docs/contributing.md/#L1" class="contribution-link">Edit this page</a>
91+
</li>
92+
</ul>
93+
</div>
94+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
95+
<h5>In this article</h5>
96+
<div></div>
97+
</nav>
98+
</div>
99+
</div>
100+
</div>
101+
</div>
102+
103+
<footer>
104+
<div class="grad-bottom"></div>
105+
<div class="footer">
106+
<div class="container">
107+
<span class="pull-right">
108+
<a href="#top">Back to top</a>
109+
</span>
110+
© 2025 AndrewClements84 · Built with DocFX
111+
112+
</div>
113+
</div>
114+
</footer>
115+
</div>
116+
117+
<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
118+
<script type="text/javascript" src="../styles/docfx.js"></script>
119+
<script type="text/javascript" src="../styles/main.js"></script>
120+
</body>
121+
</html>

0 commit comments

Comments
 (0)