Skip to content

Commit 99b1262

Browse files
author
committed
Deployed ad9903b with MkDocs version: 1.6.1
1 parent 48ef4b6 commit 99b1262

5 files changed

Lines changed: 37 additions & 6 deletions

File tree

‎agent-install.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,17 @@
411411
</span>
412412
</a>
413413

414+
</li>
415+
416+
<li class="md-nav__item">
417+
<a href="#ai-guided-setup-recommended-for-new-users" class="md-nav__link">
418+
<span class="md-ellipsis">
419+
420+
AI-Guided Setup (Recommended for New Users)
421+
422+
</span>
423+
</a>
424+
414425
</li>
415426

416427
<li class="md-nav__item">
@@ -1361,6 +1372,17 @@
13611372
</span>
13621373
</a>
13631374

1375+
</li>
1376+
1377+
<li class="md-nav__item">
1378+
<a href="#ai-guided-setup-recommended-for-new-users" class="md-nav__link">
1379+
<span class="md-ellipsis">
1380+
1381+
AI-Guided Setup (Recommended for New Users)
1382+
1383+
</span>
1384+
</a>
1385+
13641386
</li>
13651387

13661388
<li class="md-nav__item">
@@ -1866,6 +1888,15 @@ <h2 id="table-of-contents">Table of Contents<a class="headerlink" href="#table-o
18661888
<li><a href="#skills-reference">Skills Reference</a></li>
18671889
<li><a href="#uninstalling">Uninstalling</a></li>
18681890
</ul>
1891+
<h2 id="ai-guided-setup-recommended-for-new-users">AI-Guided Setup (Recommended for New Users)<a class="headerlink" href="#ai-guided-setup-recommended-for-new-users" title="Permanent link">&para;</a></h2>
1892+
<p>The <strong>install-mentor agent</strong> can guide you through the entire setup process conversationally. It detects your environment, installs packages, configures studyctl, and verifies everything works using <code>studyctl doctor</code>.</p>
1893+
<p>The prompt lives at <a href="../agents/shared/install-mentor.md"><code>agents/shared/install-mentor.md</code></a> and works with any AI coding tool. To use it:</p>
1894+
<div class="highlight"><pre><span></span><code><span class="c1"># In Claude Code — just ask:</span>
1895+
<span class="c1"># &quot;Read agents/shared/install-mentor.md and follow it to set up studyctl&quot;</span>
1896+
1897+
<span class="c1"># Or in any AI tool that can run shell commands, paste the prompt contents</span>
1898+
</code></pre></div>
1899+
<p>The install-mentor uses <code>studyctl doctor --json</code> as its contract — it parses the health check output and fixes issues automatically (up to 3 iterations).</p>
18691900
<h2 id="what-are-ai-agents">What are AI Agents?<a class="headerlink" href="#what-are-ai-agents" title="Permanent link">&para;</a></h2>
18701901
<p>AI agents are custom personas you load into tools like kiro-cli or Claude Code. Instead of a generic assistant, you get a Socratic mentor that knows your learning style, tracks your progress, and teaches through questioning rather than lecturing.</p>
18711902
<p>This project ships agents for five platforms:

‎contributing.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1196,7 +1196,7 @@ <h2 id="code-style">Code Style<a class="headerlink" href="#code-style" title="Pe
11961196
<li><strong>Linter/formatter</strong>: <a href="https://docs.astral.sh/ruff/">ruff</a> (configured in each <code>pyproject.toml</code>)</li>
11971197
<li><strong>Type checker</strong>: <a href="https://github.com/microsoft/pyright">pyright</a> in basic mode</li>
11981198
<li><strong>Line length</strong>: 100 characters</li>
1199-
<li><strong>Target</strong>: Python 3.10+ (agent-session-tools), Python 3.12+ (studyctl)</li>
1199+
<li><strong>Target</strong>: Python 3.12+ (both studyctl and agent-session-tools)</li>
12001200
</ul>
12011201
<p>Run checks manually:</p>
12021202
<div class="highlight"><pre><span></span><code>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>.<span class="w"> </span><span class="c1"># Lint</span>

‎search/search_index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎search/search_index.json‎

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

‎setup-guide.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2002,7 +2002,7 @@ <h2 id="table-of-contents">Table of Contents<a class="headerlink" href="#table-o
20022002
</ul>
20032003
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
20042004
<ul>
2005-
<li><strong>Python 3.10+</strong> (studyctl requires 3.12+, agent-session-tools works with 3.10+)</li>
2005+
<li><strong>Python 3.12+</strong> (both studyctl and agent-session-tools require 3.12+)</li>
20062006
<li><strong><a href="https://docs.astral.sh/uv/">uv</a></strong> — Python package manager</li>
20072007
<li><strong>Obsidian</strong> — for study notes (any vault structure works)</li>
20082008
<li><strong>Optional</strong>: <code>notebooklm-py</code> for Google NotebookLM sync</li>
@@ -2015,7 +2015,7 @@ <h3 id="automatic-recommended">Automatic (recommended)<a class="headerlink" href
20152015
./scripts/install.sh
20162016
</code></pre></div>
20172017
<p>This will:
2018-
1. Verify Python 3.10+ is installed
2018+
1. Verify Python 3.12+ is installed
20192019
2. Install <code>uv</code> if not already available
20202020
3. Run <code>uv sync</code> to install both packages
20212021
4. Run <code>install-agents.sh</code> to set up AI agent definitions
@@ -2425,7 +2425,7 @@ <h2 id="windows-wsl2">Windows (WSL2)<a class="headerlink" href="#windows-wsl2" t
24252425
<h3 id="prerequisites_1">Prerequisites<a class="headerlink" href="#prerequisites_1" title="Permanent link">&para;</a></h3>
24262426
<ol>
24272427
<li>Install WSL2 with Ubuntu: <code>wsl --install -d Ubuntu</code></li>
2428-
<li>Inside WSL2, install Python 3.10+ and uv:
2428+
<li>Inside WSL2, install Python 3.12+ and uv:
24292429
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-LsSf<span class="w"> </span>https://astral.sh/uv/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
24302430
</code></pre></div></li>
24312431
<li>Clone and install as normal (all commands run inside WSL2)</li>

0 commit comments

Comments
 (0)