README.md: project landing page and chapter index
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 82/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- bun, typescript
- Ambito
- documentation
Direzione di ricerca
Inizia da OUTLINE.md e dal punto di ingresso esistente examples/01-sdk-first-request/hello.ts, quindi crea la README.md del repository. Includi la presentazione richiesta del progetto, i prerequisiti, la configurazione di Bun, le variabili d'ambiente, la struttura, i link ai capitoli, le convenzioni, lo stato, la nota sui contributi e la licenza. Il lavoro è completato quando la README è stata sottoposta a commit in main, i link funzionano, l'avvio rapido funziona su un clone pulito e la punteggiatura usa esclusivamente ASCII.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Write the repository README.md - the landing page for the Build Your Own Coding Agent tutorial. The full source material lives in OUTLINE.md; the README is the reader-facing front door.
Goal: A newcomer can land on the repo, understand what they will build, set up their environment, and navigate to any chapter.
What it should contain
- Title + one-paragraph pitch (build a coding agent with the Anthropic SDK on TypeScript + Bun; ends as a streaming, tool-using Telegram + REPL agent).
- Who it is for / prerequisites (Bun, Anthropic API key, Telegram bot token from BotFather, basic TypeScript).
- Quick start:
bun add @anthropic-ai/sdk,.envsetup (ANTHROPIC_API_KEY,TELEGRAM_BOT_TOKEN), and how to run an example (bun run examples/01-sdk-first-request/hello.ts). - Repository layout (the
examples/NN-slug/convention). - Table of contents linking to each chapter (10 issues / chapter docs).
- Conventions note (TypeScript + Bun, official
@anthropic-ai/sdk, ASCII punctuation). - Status / contributing note (each chapter is tracked by its own issue: #1-#10).
- License.
Chapter index to link
- #1 The Claude SDK and Your First API Request
- #2 Streaming Responses and Message Types
- #3 Handling User Requests: REPL and Telegram Bot
- #4 Context and Conversation Management
- #5 Implementing Tools and Function Calling
- #6 Building Tool Chains and Complex Workflows
- #7 Advanced Agent Patterns
- #8 Production and Deployment
- #9 Advanced Topics: RAG, Prompt Engineering, and Fine-Tuning
- #10 Real-World Patterns: Research, Automation, and Support
Definition of done
-
README.mdwritten and committed tomain. - All chapter links resolve (to chapter docs once written, or to their tracking issues).
- Quick start verified end-to-end on a clean clone.
- ASCII punctuation only.
- Lingua principale
- TypeScript
- Stelle
- 0
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di yagop/coding-agents-tutorial
-
documentation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
documentation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 68/100
-
documentation
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
yagop/coding-agents-tutorial#8 · 1 commento ·
Tutte le issue di yagop/coding-agents-tutorial
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
copse-dev/agent-pane#2953 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
[Bug]: Matrix progress drafts fail with "Matrix runtime not initialized" during tool activity Apertabug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
calcite-components needs triage refactor
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Esri/calcite-design-system#15203 ·