docs: refresh tutorial chat styling (#129)
This commit is contained in:
+63
-23
@@ -1,41 +1,81 @@
|
||||
# Tutorials
|
||||
|
||||
Tutorials are **step-by-step learning paths**. If you’re new, start here and follow them in order.
|
||||
Tutorials walk you through Takopi step-by-step. Follow them in order if you're new.
|
||||
|
||||
If you already know what you want to do (e.g. “enable topics” or “fetch a file”), jump to **How-to**.
|
||||
If you already know what you want ("enable topics", "use worktrees"), jump to **[How-to](../how-to/index.md)**.
|
||||
|
||||
## Before you start
|
||||
## Prerequisites
|
||||
|
||||
You’ll need:
|
||||
Before starting, make sure you have:
|
||||
|
||||
- A Telegram account + a bot token
|
||||
- Python **3.14+** and `uv`
|
||||
- At least one engine CLI on your `PATH`: `codex`, `claude`, `opencode`, or `pi`
|
||||
- A **Telegram account**
|
||||
- **Python 3.14+** and **uv** ([install uv](https://docs.astral.sh/uv/getting-started/installation/))
|
||||
- At least one agent CLI on your `PATH`:
|
||||
|
||||
## 1) Install and onboard
|
||||
| Agent | Install |
|
||||
|-------|---------|
|
||||
| Codex | `npm install -g @openai/codex` |
|
||||
| Claude Code | `npm install -g @anthropic-ai/claude-code` |
|
||||
| OpenCode | `npm install -g opencode-ai@latest` |
|
||||
| Pi | `npm install -g @mariozechner/pi-coding-agent` |
|
||||
|
||||
Get Takopi installed, create a bot token, capture your chat id, and pick a default engine.
|
||||
You only need one to get started. Takopi auto-detects what's available.
|
||||
|
||||
- [Install & onboard](install-and-onboard.md)
|
||||
## The tutorials
|
||||
|
||||
## 2) Your first run
|
||||
### 1. Install and onboard
|
||||
|
||||
Run Takopi in a repo, send your first task from Telegram, and learn the two core controls:
|
||||
Set up Takopi, create a Telegram bot, and generate your config.
|
||||
|
||||
- reply-to-continue (resume)
|
||||
- cancel a run
|
||||
**Time:** ~5 minutes
|
||||
|
||||
- [First run](first-run.md)
|
||||
[Start here →](install-and-onboard.md)
|
||||
|
||||
## What to do next
|
||||
### 2. First run
|
||||
|
||||
Once you can run tasks end-to-end, you’ll usually want:
|
||||
Send your first task, watch it stream, and learn the core loop: run → continue → cancel.
|
||||
|
||||
- Register a repo as a **project alias**: [How-to: Projects](../how-to/projects.md)
|
||||
- Run work on a branch in a dedicated **worktree**: [How-to: Worktrees](../how-to/worktrees.md)
|
||||
- Keep long-running work organized in threads: [How-to: Topics](../how-to/topics.md)
|
||||
**Time:** ~10 minutes
|
||||
|
||||
When you need exact knobs and defaults:
|
||||
[Continue →](first-run.md)
|
||||
|
||||
- [Reference: Configuration](../reference/config.md)
|
||||
- [Reference: Commands & directives](../reference/commands-and-directives.md)
|
||||
### 3. Projects and branches
|
||||
|
||||
Register a repo as a project so you can target it from anywhere. Run tasks on feature branches without leaving your main worktree.
|
||||
|
||||
**Time:** ~10 minutes
|
||||
|
||||
[Continue →](projects-and-branches.md)
|
||||
|
||||
### 4. Multi-engine workflows
|
||||
|
||||
Use different agents for different tasks. Set defaults per chat or topic.
|
||||
|
||||
**Time:** ~5 minutes
|
||||
|
||||
[Continue →](multi-engine.md)
|
||||
|
||||
## What you'll build
|
||||
|
||||
By the end of these tutorials, you'll have:
|
||||
|
||||
```
|
||||
~/.takopi/takopi.toml
|
||||
├── bot_token + chat_id configured
|
||||
├── default_engine set
|
||||
└── projects.your-repo registered
|
||||
```
|
||||
|
||||
And you'll know how to:
|
||||
|
||||
- Send tasks from Telegram and watch progress stream
|
||||
- Continue conversations by replying
|
||||
- Cancel runs mid-flight
|
||||
- Target specific repos and branches
|
||||
- Switch between agents on the fly
|
||||
|
||||
## After the tutorials
|
||||
|
||||
- **[How-to guides](../how-to/index.md)** — goal-oriented recipes (topics, file transfer, voice notes)
|
||||
- **[Reference](../reference/index.md)** — exact config keys, commands, and contracts
|
||||
- **[Explanation](../explanation/index.md)** — architecture and design rationale
|
||||
|
||||
Reference in New Issue
Block a user