-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathllms.txt
More file actions
194 lines (149 loc) · 6.63 KB
/
llms.txt
File metadata and controls
194 lines (149 loc) · 6.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# Team-X Documentation Index
**AI-optimized documentation index for LLM consumption**
---
## Project Overview
**Project:** Team-X
**Description:** AI-powered workforce desktop application
**Version:** 1.0.0
**Repository:** https://github.com/Git-Rocky-Stack/Team-X
**Documentation:** https://github.com/Git-Rocky-Stack/Team-X/tree/main/docs
---
## Quick Links
**Getting Started:**
- Quick Start Guide: docs/user-guide/getting-started/quick-start.md
- Installation: https://github.com/Git-Rocky-Stack/Team-X/releases (Team-X is local-first; no account or signup required)
**Core Documentation:**
- Comprehensive User Guide: docs/user-guide/comprehensive-user-guide.md
- FAQ: docs/user-guide/faq.md
- Troubleshooting: docs/user-guide/troubleshooting.md
**Developers:**
- Developer Reference: docs/developer-guide/api-reference.md
- MCP Protocol: https://modelcontextprotocol.io
- Source code: https://github.com/Git-Rocky-Stack/Team-X
**Community:**
- GitHub: https://github.com/Git-Rocky-Stack/Team-X
- Issues: https://github.com/Git-Rocky-Stack/Team-X/issues
- Releases: https://github.com/Git-Rocky-Stack/Team-X/releases
---
## Documentation Structure
```
docs/
├── user-guide/
│ ├── comprehensive-user-guide.md # Main documentation (500+ sections)
│ ├── getting-started/
│ │ └── quick-start.md # 15-minute setup guide
│ ├── scenarios/ # Real-world scenarios (7 scenarios)
│ │ ├── 01-product-development-lifecycle.md
│ │ ├── 02-cost-optimization-playbook.md
│ │ ├── 03-failure-recovery-workflows.md
│ │ ├── 04-cross-functional-collaboration.md
│ │ ├── 05-autonomous-routine-governance.md
│ │ ├── 06-multi-workspace-operations.md
│ │ └── 07-shift-handoff-playbook.md
│ ├── templates/ # Reusable templates
│ │ ├── handoff-document.md
│ │ ├── meeting-agenda.md
│ │ ├── ticket-templates.md
│ │ ├── routine-templates.md
│ │ └── README.md
│ ├── video-scripts/ # Video tutorial scripts
│ │ └── README.md
│ ├── faq.md # Frequently asked questions
│ ├── troubleshooting.md # Common issues and solutions
│ ├── glossary.md # 200+ term glossary
│ ├── keyboard-shortcuts.md # Power user shortcuts
│ ├── accessibility-guide.md # WCAG compliance
│ ├── migration-guide.md # Platform migration
│ └── cli-reference.md # CLI and Command Palette
├── developer-guide/
│ └── api-reference.md # Architecture, MCP, role packs, internal IPC
└── README.md # Project overview
```
---
## Key Concepts
**Team-X:** Desktop application providing AI-powered workforce
**Employee:** AI agent with curated role (57 roles available)
**Ticket:** Work unit assigned to employee
**Agent Run:** Single execution of agent working on ticket
**Mission Control:** Real-time operations dashboard
**Command Palette:** NLU-driven command interface (Ctrl+K/Cmd+K)
**Copilot:** Proactive intelligence analyzer
**Autonomy Control Plane:** Governance system (runtimes, routines, budgets)
**Workspace:** Company container (employees, tickets, budgets)
**Provider:** AI model provider (Anthropic, OpenAI, Ollama)
**MCP:** Model Context Protocol for extending agent capabilities
---
## Core Features
1. **AI Workforce:** Hire AI employees with specialized roles
2. **Natural Language Interface:** Command Palette (Ctrl+K)
3. **Mission Control Dashboard:** Real-time operations overview
4. **Autonomous Execution:** Agents work independently on tickets
5. **Budget Governance:** Per-ticket and monthly budget controls
6. **Multi-Workspace:** Manage multiple clients/projects
7. **Provider Routing:** Anthropic, OpenAI, Ollama with failover
8. **Routine Automation:** Scheduled recurring tasks
9. **Copilot Insights:** Proactive recommendations
10. **Audit Trail:** Complete event logging
---
## Quick Reference
### Keyboard Shortcuts
- `Ctrl+K` / `Cmd+K` — Open Command Palette
- `Ctrl+T` / `Cmd+T` — Tickets Panel
- `Ctrl+E` / `Cmd+E` — Employees Panel
- `Ctrl+A` / `Cmd+A` — Autonomy Control Plane
- `Ctrl+D` / `Cmd+D` — Mission Control Dashboard
- `Esc` — Close/go back
### Command Palette Examples
- "Create ticket for fixing login bug"
- "Hire a UI/UX designer"
- "Show our spend this month"
- "Assign all open tickets to Alex"
- "Cancel all running agents"
### Employee Roles (57 total)
**Engineering:** Full Stack Engineer, Backend Engineer, Frontend Engineer, DevOps Engineer, Security Engineer, QA Engineer, Database Architect
**Design:** UI/UX Designer, Graphic Designer, Product Designer, Design Systems Lead
**Product:** Product Manager, Technical Writer, Business Analyst
**Marketing:** Content Writer, SEO Specialist, Social Media Manager, Email Marketing Specialist
**Data:** Data Analyst, Data Scientist, ML Engineer
**Operations:** Project Manager, Scrum Master, Release Manager
### Platform Support
- **Windows:** Windows 10/11 (64-bit)
- **macOS:** macOS 11+ (Big Sur or later)
- **Linux:** Ubuntu 20.04+, Debian 11+
---
## Common Use Cases
**Product Development:**
- Hire product team (PM, Designer, Engineers)
- Create tickets for features, bugs, reviews
- Agents collaborate autonomously
- Track progress in Mission Control
**Agency Work:**
- One workspace per client
- Master policies for consistency
- Employee sharing across workspaces
- Client-specific billing
**Shift Handoff:**
- Pre-handoff validation with Doctor
- Comprehensive handoff documentation
- Backup operator coverage
- Post-handoff reintegration
**Cost Optimization:**
- Budget caps and alerts
- Provider selection (cheaper models for routine work)
- Routine schedule optimization
- Spend analytics via Copilot
---
## Support Resources
**Documentation:** github.com/Git-Rocky-Stack/Team-X/tree/main/docs
**Source code:** github.com/Git-Rocky-Stack/Team-X
**Issue tracker:** github.com/Git-Rocky-Stack/Team-X/issues
**Discussions / Q&A:** github.com/Git-Rocky-Stack/Team-X/discussions
**Releases:** github.com/Git-Rocky-Stack/Team-X/releases
Team-X is open-source and community-supported. There is no hosted support, help center, status page, or email — open an issue on GitHub for bugs and a discussion for questions.
---
## License
MIT License — See LICENSE file for details
---
## Version
Documentation Version: 1.0.0
Last Updated: 2026-05-03