Skip to content

Commit bc08c6d

Browse files
committed
Docs.
Signed-off-by: Jose Alekhinne <alekhinejose@gmail.com>
1 parent 9ffc800 commit bc08c6d

3 files changed

Lines changed: 35 additions & 7 deletions

File tree

docs/home/prompting-guide.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ icon: lucide/message-circle
1111

1212
![ctx](../images/ctx-banner.png)
1313

14+
!!! note "New to `ctx`?"
15+
This guide references context files like `TASKS.md`, `DECISIONS.md`,
16+
and `LEARNINGS.md`:
17+
18+
These are plain Markdown files that `ctx`
19+
maintains in your project's `.context/` directory.
20+
21+
If terms like "*context packet*" or "*session ceremony*" are unfamiliar,
22+
23+
* start with the [`ctx` Manifesto](../index.md) for the **why**,
24+
* [About](../home/about.md) for the **big picture**,
25+
* then [Getting Started](../home/getting-started.md) to set up **your first
26+
project**.
27+
1428
## Literature Matters
1529

1630
Effective prompts for working with AI assistants in `ctx`-enabled projects.
@@ -45,10 +59,10 @@ Do you remember what we were working on?
4559

4660
This question **implies** prior context exists. The AI checks files
4761
rather than admitting ignorance. The expected response cites specific
48-
context (session names, task counts, decisions), not vague summaries.
62+
context (*session names, task counts, decisions*), not vague summaries.
4963

50-
If the AI instead narrates its discovery process ("Let me check if
51-
there are files..."), it has not loaded `CLAUDE.md` or
64+
If the AI instead narrates its discovery process ("*Let me check if
65+
there are files...*"), it has not loaded `CLAUDE.md` or
5266
`AGENT_PLAYBOOK.md` properly.
5367

5468
### "*What's the current state?*"

site/home/prompting-guide/index.html

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3920,6 +3920,20 @@
39203920
<h1>Prompting Guide</h1>
39213921

39223922
<p><img alt="ctx" src="../../images/ctx-banner.png" /></p>
3923+
<div class="admonition note">
3924+
<p class="admonition-title">New to <code>ctx</code>?</p>
3925+
<p>This guide references context files like <code>TASKS.md</code>, <code>DECISIONS.md</code>,
3926+
and <code>LEARNINGS.md</code>:</p>
3927+
<p>These are plain Markdown files that <code>ctx</code>
3928+
maintains in your project's <code>.context/</code> directory.</p>
3929+
<p>If terms like "<em>context packet</em>" or "<em>session ceremony</em>" are unfamiliar,</p>
3930+
<ul>
3931+
<li>start with the <a href="../../"><code>ctx</code> Manifesto</a> for the <strong>why</strong>,</li>
3932+
<li><a href="../../home/about/">About</a> for the <strong>big picture</strong>,</li>
3933+
<li>then <a href="../../home/getting-started/">Getting Started</a> to set up <strong>your first
3934+
project</strong>.</li>
3935+
</ul>
3936+
</div>
39233937
<h2 id="literature-matters">Literature Matters<a class="headerlink" href="#literature-matters" title="Permanent link">&para;</a></h2>
39243938
<p>Effective prompts for working with AI assistants in <code>ctx</code>-enabled projects.</p>
39253939
<div class="admonition tip help your ai sidekick">
@@ -3945,9 +3959,9 @@ <h3 id="do-you-remember">"<em>Do you remember?</em>"<a class="headerlink" href="
39453959
</span></code></pre></div>
39463960
<p>This question <strong>implies</strong> prior context exists. The AI checks files
39473961
rather than admitting ignorance. The expected response cites specific
3948-
context (session names, task counts, decisions), not vague summaries.</p>
3949-
<p>If the AI instead narrates its discovery process ("Let me check if
3950-
there are files..."), it has not loaded <code>CLAUDE.md</code> or
3962+
context (<em>session names, task counts, decisions</em>), not vague summaries.</p>
3963+
<p>If the AI instead narrates its discovery process ("<em>Let me check if
3964+
there are files...</em>"), it has not loaded <code>CLAUDE.md</code> or
39513965
<code>AGENT_PLAYBOOK.md</code> properly.</p>
39523966
<h3 id="whats-the-current-state">"<em>What's the current state?</em>"<a class="headerlink" href="#whats-the-current-state" title="Permanent link">&para;</a></h3>
39533967
<p>Prompts reading of <code>TASKS.md</code>, recent sessions, and status overview.</p>

site/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)