@@ -4,83 +4,64 @@ Comprehensive documentation for Termwright - Playwright for terminals.
44
55## 📚 Documentation Index
66
7- ### Getting Started
8- - ** [ Quick Start ] ( ./quick-start .md ) ** - Get up and running in 5 minutes
9- - ** [ Installation ] ( ./installation .md ) ** - Installation and setup guide
7+ ### Core Documentation
8+ - ** [ API Reference ] ( ./api .md ) ** - Complete API documentation for programmatic usage
9+ - ** [ MCP Tools ] ( ./mcp-tools .md ) ** - MCP server tools reference for AI agents
1010- ** [ Examples Guide] ( ./examples.md ) ** - Complete guide to all examples
1111
12- ### Core Concepts
13- - ** [ API Reference] ( ./api-reference.md ) ** - Complete API documentation
14- - ** [ Pattern Matching] ( ./pattern-matching.md ) ** - Advanced pattern matching guide
15- - ** [ Session Management] ( ./session-management.md ) ** - Managing terminal sessions
16-
17- ### Advanced Topics
18- - ** [ Testing Guide] ( ./testing-guide.md ) ** - Automated testing strategies
19- - ** [ Best Practices] ( ./best-practices.md ) ** - Tips and recommendations
20- - ** [ Troubleshooting] ( ./troubleshooting.md ) ** - Common issues and solutions
21-
22- ### MCP Integration
23- - ** [ MCP Server] ( ./mcp-server.md ) ** - Using with Model Context Protocol
24- - ** [ AI Agents] ( ./ai-agents.md ) ** - Building AI agents with Termwright
12+ ### Example Code
13+ - ** [ Getting Started Examples] ( ../examples/getting-started/ ) ** - Basic terminal operations
14+ - ** [ Advanced Examples] ( ../examples/advanced/ ) ** - Pattern matching and multi-session
15+ - ** [ Testing Examples] ( ../examples/testing/ ) ** - CLI testing automation
2516
2617## 🚀 Quick Links
2718
2819| I want to... | Go to... |
2920| --------------| ----------|
30- | Learn the basics | [ Quick Start] ( ./quick-start.md ) |
21+ | Use as a library | [ API Reference] ( ./api.md ) |
22+ | Use with AI/MCP | [ MCP Tools] ( ./mcp-tools.md ) |
3123| See code examples | [ Examples Guide] ( ./examples.md ) |
32- | Look up a method | [ API Reference] ( ./api-reference.md ) |
33- | Test my CLI app | [ Testing Guide] ( ./testing-guide.md ) |
34- | Use with AI | [ MCP Server] ( ./mcp-server.md ) |
35- | Fix an issue | [ Troubleshooting] ( ./troubleshooting.md ) |
24+ | Browse examples | [ Examples Directory] ( ../examples/ ) |
3625
3726## 📖 Documentation Structure
3827
3928```
4029docs/
41- ├── README.md # This file
42- ├── quick-start.md # 5-minute quick start
43- ├── installation.md # Installation guide
44- ├── examples.md # Examples index and guide
45- ├── api-reference.md # Complete API documentation
46- ├── pattern-matching.md # Pattern matching guide
47- ├── session-management.md # Session lifecycle and management
48- ├── testing-guide.md # Testing strategies
49- ├── best-practices.md # Tips and recommendations
50- ├── troubleshooting.md # Common issues
51- ├── mcp-server.md # MCP integration
52- └── ai-agents.md # AI agent development
30+ ├── README.md # This file
31+ ├── api.md # API reference for library usage
32+ ├── mcp-tools.md # MCP tools reference for AI agents
33+ └── examples.md # Examples guide and overview
34+
35+ examples/
36+ ├── getting-started/ # Basic examples
37+ ├── advanced/ # Advanced patterns
38+ └── testing/ # Testing examples
5339```
5440
5541## 🎯 Documentation by Role
5642
57- ### For Developers
58- 1 . [ Quick Start] ( ./quick-start.md )
59- 2 . [ API Reference] ( ./api-reference.md )
60- 3 . [ Examples Guide] ( ./examples.md )
61- 4 . [ Best Practices] ( ./best-practices.md )
43+ ### For Developers (Library Usage)
44+ 1 . [ API Reference] ( ./api.md )
45+ 2 . [ Getting Started Examples] ( ../examples/getting-started/ )
46+ 3 . [ Advanced Examples] ( ../examples/advanced/ )
6247
63- ### For QA Engineers
64- 1 . [ Testing Guide] ( ./testing-guide.md )
65- 2 . [ Examples - Testing] ( ./examples.md#testing )
66- 3 . [ Pattern Matching] ( ./pattern-matching.md )
67- 4 . [ Troubleshooting] ( ./troubleshooting.md )
48+ ### For QA Engineers (Testing)
49+ 1 . [ Testing Examples] ( ../examples/testing/ )
50+ 2 . [ API Reference] ( ./api.md )
51+ 3 . [ Advanced Examples] ( ../examples/advanced/ )
6852
69- ### For AI/ML Engineers
70- 1 . [ MCP Server] ( ./mcp-server.md )
71- 2 . [ AI Agents] ( ./ai-agents.md )
72- 3 . [ API Reference] ( ./api-reference.md )
73- 4 . [ Examples Guide] ( ./examples.md )
53+ ### For AI/ML Engineers (MCP Integration)
54+ 1 . [ MCP Tools Reference] ( ./mcp-tools.md )
55+ 2 . [ Examples Guide] ( ./examples.md )
56+ 3 . [ Main README] ( ../README.md )
7457
75- ## 🔍 Search Documentation
58+ ## 🔧 Key Features
7659
77- Looking for something specific?
78-
79- - ** Commands** : [ API Reference - Methods] ( ./api-reference.md#methods )
80- - ** Patterns** : [ Pattern Matching Guide] ( ./pattern-matching.md )
81- - ** Errors** : [ Troubleshooting] ( ./troubleshooting.md )
82- - ** Examples** : [ Examples Guide] ( ./examples.md )
83- - ** Testing** : [ Testing Guide] ( ./testing-guide.md )
60+ - ** Universal tmux-based terminals** - Works with any terminal emulator
61+ - ** Headless and visible modes** - PTY for automation, tmux for visibility
62+ - ** Pattern matching** - Wait for regex patterns in output
63+ - ** Session management** - Spawn, control, and cleanup multiple sessions
64+ - ** MCP integration** - Built-in Model Context Protocol server for AI agents
8465
8566## 📝 Contributing to Documentation
8667
@@ -90,8 +71,6 @@ Found an error or want to improve the docs?
90712 . Edit the markdown files in ` docs/ `
91723 . Submit a pull request
9273
93- See [ CONTRIBUTING.md] ( ../CONTRIBUTING.md ) for details.
94-
9574## 📄 License
9675
9776MIT License - see [ LICENSE] ( ../LICENSE ) for details.
0 commit comments