README.md: project landing page and chapter index

Open Beginner friendly
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
bun, typescript
Domain
documentation

Research direction

Start with OUTLINE.md and the existing examples/01-sdk-first-request/hello.ts entry point, then create the repository README.md. Include the requested project pitch, prerequisites, Bun setup, environment variables, layout, chapter links, conventions, status, contributing note, and license. Done means the README is committed to main, links resolve, the quick start works on a clean clone, and punctuation is ASCII-only.

Written by the indexing model from the issue text.

Description

documentation

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, .env setup (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. #1 The Claude SDK and Your First API Request
  2. #2 Streaming Responses and Message Types
  3. #3 Handling User Requests: REPL and Telegram Bot
  4. #4 Context and Conversation Management
  5. #5 Implementing Tools and Function Calling
  6. #6 Building Tool Chains and Complex Workflows
  7. #7 Advanced Agent Patterns
  8. #8 Production and Deployment
  9. #9 Advanced Topics: RAG, Prompt Engineering, and Fine-Tuning
  10. #10 Real-World Patterns: Research, Automation, and Support
Definition of done
  • README.md written and committed to main.
  • 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.
Dominant language
TypeScript
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from yagop/coding-agents-tutorial

All issues in yagop/coding-agents-tutorial

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.