telo3-ai 5.0.4 → 5.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "telo3-ai",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.6",
|
|
4
4
|
"description": "AI development framework and project-context system for coding agents. Provides persistent memory, quality frameworks, and systematic engineering practices for AI assistants like Claude, ChatGPT, GitHub Copilot, and Cursor.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"type": "module",
|
package/skills/telo3/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
3
|
-
version: 5.0.
|
|
2
|
+
name: telo3
|
|
3
|
+
version: 5.0.5
|
|
4
4
|
description: AI development framework with project-context system, quality frameworks, and systematic engineering practices
|
|
5
5
|
author: Jeet (@jeet1511)
|
|
6
6
|
license: MIT
|
|
@@ -9,7 +9,7 @@ repository: https://github.com/Jeet1511/telo3
|
|
|
9
9
|
|
|
10
10
|
# Telo3 — AI Development Skill
|
|
11
11
|
|
|
12
|
-
**Version:** 5.0.
|
|
12
|
+
**Version:** 5.0.5
|
|
13
13
|
**Purpose:** Make AI coding agents understand, build, maintain, audit, secure, optimize, and document software projects systematically instead of "vibe coding."
|
|
14
14
|
**Created by:** [Jeet (@Jeet1511)](https://github.com/Jeet1511)
|
|
15
15
|
**Repository:** https://github.com/Jeet1511/telo3
|
|
@@ -37,639 +37,279 @@ This skill system provides AI agents with persistent project memory, engineering
|
|
|
37
37
|
Activate this skill when:
|
|
38
38
|
|
|
39
39
|
- Starting work on a new project
|
|
40
|
-
- Onboarding to an existing
|
|
41
|
-
- The user mentions "project context" or "project documentation"
|
|
42
|
-
- You need to understand project requirements, architecture, or design system
|
|
43
|
-
- Making architectural decisions
|
|
44
|
-
- Adding features that affect security, privacy, or compliance
|
|
40
|
+
- Onboarding to an existing project
|
|
45
41
|
- Auditing project quality
|
|
46
42
|
- Synchronizing documentation with implementation
|
|
47
43
|
- The project contains `project-context/` or similar context files (any location works)
|
|
48
44
|
|
|
49
45
|
## Quick Start (30 seconds)
|
|
50
46
|
|
|
51
|
-
**
|
|
52
|
-
**THEN:** Read `memory.md` (current project state)
|
|
53
|
-
**FINALLY:** Load other context as needed for your task
|
|
47
|
+
**Read in this order:**
|
|
54
48
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
# Or add to your project
|
|
61
|
-
git submodule add https://github.com/Jeet1511/telo3.git telo3
|
|
62
|
-
```
|
|
49
|
+
1. `AI-CONTEXT.md` — 30-second overview (you're reading it now)
|
|
50
|
+
2. `project-context/prd.md` — What & why
|
|
51
|
+
3. `project-context/architecture.md` — How it's built
|
|
52
|
+
4. `project-context/memory.md` — Recent context
|
|
63
53
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
**Token Optimization:** Don't read everything. Read what you need.
|
|
54
|
+
Then proceed with coding systematically.
|
|
67
55
|
|
|
68
56
|
---
|
|
69
57
|
|
|
70
|
-
##
|
|
71
|
-
|
|
72
|
-
This system uses six distinct documents with clear responsibilities:
|
|
58
|
+
## The 6-Document Context System
|
|
73
59
|
|
|
74
|
-
| Document |
|
|
75
|
-
|
|
76
|
-
| **prd.md** | WHAT
|
|
77
|
-
| **architecture.md** | HOW
|
|
78
|
-
| **rules.md** | HOW to
|
|
79
|
-
| **design.md** |
|
|
80
|
-
| **tasks.md** | WHAT
|
|
81
|
-
| **memory.md** | CURRENT STATE —
|
|
60
|
+
| Document | Purpose | When to Read | When to Update |
|
|
61
|
+
|----------|---------|--------------|----------------|
|
|
62
|
+
| **prd.md** | WHAT & WHY — Requirements, vision, users | Always first | When requirements change |
|
|
63
|
+
| **architecture.md** | HOW it's built — Tech stack, structure | Before changing structure | When architecture changes |
|
|
64
|
+
| **rules.md** | HOW to code — Standards, security, testing | Before coding | When standards evolve |
|
|
65
|
+
| **design.md** | WHAT it looks like — UI/UX, brand, components | Before UI work | When design system changes |
|
|
66
|
+
| **tasks.md** | WHAT to do — Current sprint, backlog, done | Daily | When tasks change |
|
|
67
|
+
| **memory.md** | CURRENT STATE — Recent work, decisions, continuity | Every session | After significant changes |
|
|
82
68
|
|
|
83
69
|
**Location:** `project-context/` or `docs/project-context/` or project root (flexible)
|
|
84
70
|
|
|
85
71
|
---
|
|
86
72
|
|
|
87
|
-
##
|
|
88
|
-
|
|
89
|
-
### For New Projects
|
|
90
|
-
|
|
91
|
-
1. **Read the user's requirements** and confirm understanding
|
|
92
|
-
2. **Create the six core documents** from templates
|
|
93
|
-
3. **Document decisions as you make them**
|
|
94
|
-
4. **Mark uncertain information** explicitly
|
|
95
|
-
5. **Never invent requirements** — ask when unclear
|
|
96
|
-
|
|
97
|
-
### For Existing Projects
|
|
98
|
-
|
|
99
|
-
1. **Inspect the repository first:**
|
|
100
|
-
- README, AGENTS.md, CLAUDE.md, .cursorrules
|
|
101
|
-
- Existing documentation
|
|
102
|
-
- package.json / requirements.txt / go.mod
|
|
103
|
-
- Source code structure
|
|
104
|
-
- Routes, components, APIs
|
|
105
|
-
- Database configuration
|
|
106
|
-
- Authentication implementation
|
|
107
|
-
- Design patterns (CSS, components)
|
|
108
|
-
- Security boundaries
|
|
109
|
-
- Privacy-sensitive functionality
|
|
110
|
-
|
|
111
|
-
2. **DO NOT blindly overwrite existing documentation**
|
|
112
|
-
3. **Integrate with existing project instructions**
|
|
113
|
-
4. **Generate the six documents based on actual implementation**
|
|
114
|
-
5. **Mark uncertain information** with TODO or UNKNOWN
|
|
115
|
-
6. **Do not modify application code** merely to initialize context
|
|
116
|
-
|
|
117
|
-
### Automated Initialization
|
|
118
|
-
|
|
119
|
-
```bash
|
|
120
|
-
# Use the provided script
|
|
121
|
-
./scripts/init-project-context.sh
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
---
|
|
125
|
-
|
|
126
|
-
## AI Coding Workflow
|
|
127
|
-
|
|
128
|
-
### BEFORE CODING
|
|
129
|
-
|
|
130
|
-
1. **Read relevant project context:**
|
|
131
|
-
- prd.md → understand requirements
|
|
132
|
-
- architecture.md → understand system structure
|
|
133
|
-
- rules.md → understand engineering standards
|
|
134
|
-
- design.md → understand visual/UX patterns
|
|
135
|
-
- tasks.md → understand planned work
|
|
136
|
-
- memory.md → understand current state
|
|
137
|
-
|
|
138
|
-
2. **Inspect actual code** in the affected area
|
|
139
|
-
|
|
140
|
-
3. **Understand the user request:**
|
|
141
|
-
- What is the goal?
|
|
142
|
-
- Which files are affected?
|
|
143
|
-
- What are the implications?
|
|
144
|
-
|
|
145
|
-
4. **Check alignment:**
|
|
146
|
-
- Does this match the architecture?
|
|
147
|
-
- Does it follow the rules?
|
|
148
|
-
- Does it match the design system?
|
|
149
|
-
- Are there security implications?
|
|
150
|
-
- Are there privacy implications?
|
|
151
|
-
- Are there performance implications?
|
|
152
|
-
- Are there accessibility implications?
|
|
153
|
-
- Are there SEO implications (if applicable)?
|
|
154
|
-
- Are there legal/compliance implications?
|
|
155
|
-
|
|
156
|
-
5. **Make a scoped plan** before writing code
|
|
157
|
-
|
|
158
|
-
### DURING CODING
|
|
159
|
-
|
|
160
|
-
- Follow the documented architecture
|
|
161
|
-
- Follow rules.md engineering standards
|
|
162
|
-
- Follow design.md visual language
|
|
163
|
-
- Reuse existing abstractions and patterns
|
|
164
|
-
- Avoid unrelated refactoring
|
|
165
|
-
- Avoid unnecessary dependencies
|
|
166
|
-
- Preserve working behavior
|
|
167
|
-
- Protect secrets (never hardcode)
|
|
168
|
-
- Protect personal data
|
|
169
|
-
- Maintain accessibility
|
|
170
|
-
- Maintain responsive behavior
|
|
171
|
-
- Maintain security boundaries
|
|
172
|
-
- Maintain performance
|
|
173
|
-
|
|
174
|
-
### AFTER CODING
|
|
175
|
-
|
|
176
|
-
1. **Verify functionality** — does it work?
|
|
177
|
-
2. **Run relevant tests/checks** if available
|
|
178
|
-
3. **Check for regressions** in related features
|
|
179
|
-
4. **Update project context:**
|
|
180
|
-
- tasks.md → mark completed, add new tasks
|
|
181
|
-
- memory.md → document important decisions, state changes
|
|
182
|
-
- architecture.md → if architecture changed
|
|
183
|
-
- design.md → if design patterns changed
|
|
184
|
-
- rules.md → if engineering standards changed
|
|
185
|
-
- prd.md → if requirements changed
|
|
186
|
-
5. **Document security/privacy/compliance changes** when relevant
|
|
187
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
## Quality Dimensions
|
|
191
|
-
|
|
192
|
-
This skill system includes specialized guidance for:
|
|
193
|
-
|
|
194
|
-
### Product Quality
|
|
195
|
-
- Requirements clarity (prd.md)
|
|
196
|
-
- Feature completeness (tasks.md)
|
|
197
|
-
- Decision tracking (memory.md)
|
|
198
|
-
|
|
199
|
-
### Engineering Quality
|
|
200
|
-
- Coding standards (rules.md)
|
|
201
|
-
- Architecture consistency (architecture.md)
|
|
202
|
-
- Technical debt tracking (memory.md)
|
|
203
|
-
|
|
204
|
-
### UI/UX Quality
|
|
205
|
-
- Design system adherence (design.md)
|
|
206
|
-
- Anti-vibe-coding rules (references/ui-quality.md)
|
|
207
|
-
- Responsive behavior
|
|
208
|
-
- Accessibility (references/accessibility-quality.md)
|
|
209
|
-
|
|
210
|
-
### SEO Quality
|
|
211
|
-
- Metadata completeness (references/seo-quality.md)
|
|
212
|
-
- Indexing strategy
|
|
213
|
-
- Performance optimization
|
|
214
|
-
- Structured data
|
|
215
|
-
|
|
216
|
-
### Security
|
|
217
|
-
- Authentication/authorization (references/security-quality.md)
|
|
218
|
-
- Input validation
|
|
219
|
-
- Secrets management
|
|
220
|
-
- Dependency security
|
|
221
|
-
|
|
222
|
-
### Privacy
|
|
223
|
-
- Data collection transparency (references/privacy-compliance.md)
|
|
224
|
-
- Third-party tracking
|
|
225
|
-
- Consent management
|
|
226
|
-
- Data retention/deletion
|
|
227
|
-
|
|
228
|
-
### Legal/Compliance
|
|
229
|
-
- Age restrictions and child safety (references/legal-compliance.md)
|
|
230
|
-
- Marketing email requirements
|
|
231
|
-
- Subscription disclosures
|
|
232
|
-
- Copyright/DMCA considerations
|
|
233
|
-
- Jurisdiction-specific requirements
|
|
234
|
-
|
|
235
|
-
### Performance
|
|
236
|
-
- Core Web Vitals (references/performance-quality.md)
|
|
237
|
-
- Optimization strategies
|
|
238
|
-
- Loading performance
|
|
239
|
-
- Runtime performance
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
## Smart Applicability
|
|
244
|
-
|
|
245
|
-
**Do not run every audit against every project.**
|
|
73
|
+
## Quality Frameworks (11 Dimensions)
|
|
246
74
|
|
|
247
|
-
|
|
75
|
+
Before implementing features, check relevant frameworks:
|
|
248
76
|
|
|
249
|
-
|
|
|
250
|
-
|
|
251
|
-
| **
|
|
252
|
-
| **
|
|
253
|
-
| **
|
|
254
|
-
| **
|
|
255
|
-
| **
|
|
256
|
-
| **
|
|
257
|
-
| **
|
|
258
|
-
| **
|
|
259
|
-
| **
|
|
77
|
+
| Framework | What It Covers | Reference File |
|
|
78
|
+
|-----------|----------------|----------------|
|
|
79
|
+
| **Security** | OWASP, auth, validation, secrets | `references/security-quality.md` |
|
|
80
|
+
| **Privacy** | GDPR, COPPA, data collection, tracking | `references/privacy-compliance.md` |
|
|
81
|
+
| **Legal** | CAN-SPAM, DMCA, age restrictions, terms | `references/legal-compliance.md` |
|
|
82
|
+
| **Accessibility** | WCAG 2.1 AA, screen readers, keyboard nav | `references/accessibility-quality.md` |
|
|
83
|
+
| **SEO** | Meta tags, semantic markup, sitemaps, Core Web Vitals | `references/seo-quality.md` |
|
|
84
|
+
| **Performance** | LCP, INP, CLS, image optimization | `references/performance-quality.md` |
|
|
85
|
+
| **UI Quality** | Anti-vibe-coding, design consistency | `references/ui-quality.md` |
|
|
86
|
+
| **Token Efficiency** | Selective loading, caveman mode | `references/token-optimization.md` |
|
|
87
|
+
| **Smart Delegation** | MCP integration, skill discovery | `references/smart-skill-delegation.md` |
|
|
88
|
+
| **Documentation** | Systematic specifications | `references/document-specification.md` |
|
|
89
|
+
| **Workflow** | AI behavior patterns | `references/workflow.md` |
|
|
260
90
|
|
|
261
91
|
---
|
|
262
92
|
|
|
263
|
-
##
|
|
93
|
+
## Token Optimization (80% Savings)
|
|
264
94
|
|
|
265
|
-
|
|
95
|
+
### Selective Context Loading
|
|
266
96
|
|
|
267
|
-
|
|
268
|
-
2. **Identify the discrepancy** — what changed and when?
|
|
269
|
-
3. **Determine which is current** — was it intentional?
|
|
270
|
-
4. **Update stale documentation** when appropriate
|
|
271
|
-
5. **Do not silently reverse intentional decisions**
|
|
272
|
-
6. **Ask the user** when the conflict represents an unresolved product decision
|
|
97
|
+
**Don't read everything.** Load documents based on task:
|
|
273
98
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
Current project documentation
|
|
282
|
-
↓
|
|
283
|
-
General engineering best practices
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
---
|
|
99
|
+
| Task Type | Read These |
|
|
100
|
+
|-----------|------------|
|
|
101
|
+
| **New feature** | prd.md, architecture.md, rules.md, tasks.md |
|
|
102
|
+
| **Bug fix** | memory.md, architecture.md, rules.md |
|
|
103
|
+
| **UI change** | design.md, rules.md, ui-quality.md |
|
|
104
|
+
| **Security audit** | security-quality.md, privacy-compliance.md, legal-compliance.md |
|
|
105
|
+
| **Onboarding** | AI-CONTEXT.md → prd.md → architecture.md |
|
|
287
106
|
|
|
288
|
-
|
|
107
|
+
### Caveman Mode (Ultra-Concise Communication)
|
|
289
108
|
|
|
290
|
-
|
|
109
|
+
**Status updates:** `✅ Task done` not "I have successfully completed..."
|
|
110
|
+
**Questions:** `DB choice: Postgres vs MongoDB?` not verbose explanations
|
|
111
|
+
**Changes:** Update `memory.md` silently, announce only major changes
|
|
291
112
|
|
|
292
|
-
|
|
293
|
-
2. **Architecture** — consistency, duplication, technical debt
|
|
294
|
-
3. **Code** — maintainability, error handling, complexity
|
|
295
|
-
4. **UI/UX** — design consistency, accessibility, vibe-coded patterns
|
|
296
|
-
5. **SEO** — metadata, indexing, performance (if applicable)
|
|
297
|
-
6. **Security** — authentication, authorization, validation, secrets
|
|
298
|
-
7. **Privacy** — data collection, tracking, consent, retention
|
|
299
|
-
8. **Legal/Compliance** — age restrictions, marketing, subscriptions, uploads
|
|
300
|
-
9. **Performance** — Core Web Vitals, optimization, loading
|
|
301
|
-
10. **Documentation** — accuracy, completeness, synchronization
|
|
302
|
-
|
|
303
|
-
See `references/project-audit.md` for detailed audit procedures.
|
|
113
|
+
**Token savings: 80%**
|
|
304
114
|
|
|
305
115
|
---
|
|
306
116
|
|
|
307
|
-
##
|
|
308
|
-
|
|
309
|
-
### When Requirements are Unclear
|
|
310
|
-
|
|
311
|
-
- **DO NOT invent requirements**
|
|
312
|
-
- Mark information as `[UNKNOWN]` or `[TODO: clarify with user]`
|
|
313
|
-
- Ask specific questions to resolve ambiguity
|
|
314
|
-
- Document assumptions explicitly
|
|
117
|
+
## Smart Skill Delegation
|
|
315
118
|
|
|
316
|
-
|
|
119
|
+
**Before implementing, check:**
|
|
120
|
+
- Does skill exist for this? (check your AI's skills directory)
|
|
121
|
+
- Is there MCP tool? (figma, context7, stripe, etc.)
|
|
122
|
+
- Would sub-agent do better? (if your AI supports delegation)
|
|
317
123
|
|
|
318
|
-
|
|
319
|
-
-
|
|
320
|
-
-
|
|
321
|
-
-
|
|
124
|
+
**Common delegations:**
|
|
125
|
+
- UI/Design → figma skill
|
|
126
|
+
- Payments → stripe MCP
|
|
127
|
+
- Auth → authentication skills
|
|
128
|
+
- API docs → openapi tools
|
|
129
|
+
- Testing → testing frameworks
|
|
322
130
|
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
- **This skill is a decision-support tool, not legal advice**
|
|
326
|
-
- Identify potentially applicable laws/regulations
|
|
327
|
-
- Distinguish technical requirements from legal requirements
|
|
328
|
-
- Verify current requirements from authoritative sources when accuracy matters
|
|
329
|
-
- **Never claim "legally compliant" without proper evidence and scope**
|
|
330
|
-
- Recommend consulting qualified legal counsel for compliance verification
|
|
131
|
+
See `references/smart-skill-delegation.md` for complete guide.
|
|
331
132
|
|
|
332
133
|
---
|
|
333
134
|
|
|
334
|
-
## Anti-Vibe-Coding
|
|
335
|
-
|
|
336
|
-
**Vibe-coded patterns are not absolutely prohibited** — use them when justified by the actual product, brand, UX, accessibility, or design system.
|
|
337
|
-
|
|
338
|
-
### Identify and Avoid Generic AI Aesthetics:
|
|
339
|
-
|
|
340
|
-
- Harsh/arbitrary gradients and rainbow colors
|
|
341
|
-
- Generic purple/black AI palettes or arbitrary neon
|
|
342
|
-
- Excessive shadows, rounded corners, glassmorphism
|
|
343
|
-
- Inconsistent icon usage and decorative emojis
|
|
344
|
-
- Repetitive 3-card feature sections
|
|
345
|
-
- Generic bento grids without purpose
|
|
346
|
-
- Radial orbs, dot grids, sparkle icons
|
|
347
|
-
- Animated arrows and terminal-window aesthetics without justification
|
|
348
|
-
- Meaningless hover animations
|
|
349
|
-
- Generic SaaS layouts and copy-paste components
|
|
350
|
-
- "It's not X, it's Y" generic marketing copy
|
|
351
|
-
- Checkmark-heavy feature lists
|
|
352
|
-
- Unnecessary three-tier pricing
|
|
353
|
-
- Fake product demonstrations, statistics, testimonials
|
|
354
|
-
- Decorative UI with no purpose
|
|
355
|
-
- Excessive animation
|
|
356
|
-
- Inconsistent typography and spacing
|
|
357
|
-
|
|
358
|
-
**Before implementing a pattern, ask:**
|
|
359
|
-
- Does the actual design system justify this?
|
|
360
|
-
- Does the brand personality support this?
|
|
361
|
-
- Does this serve the user experience?
|
|
362
|
-
- Is this consistent with existing UI?
|
|
363
|
-
|
|
364
|
-
See `references/ui-quality.md` for detailed guidance.
|
|
135
|
+
## Anti-Vibe-Coding Framework
|
|
365
136
|
|
|
366
|
-
|
|
137
|
+
**What is vibe coding?**
|
|
138
|
+
Generic AI aesthetics: purple/black themes, excessive gradients, arbitrary shadows, decorative-only UI, fake statistics, random tech choices.
|
|
367
139
|
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
### Third-Party Fonts / External Resources
|
|
371
|
-
|
|
372
|
-
Audit externally hosted fonts, scripts, analytics, CDNs:
|
|
373
|
-
- Can loading disclose IP addresses or identifiers to third parties?
|
|
374
|
-
- Is self-hosting more appropriate for privacy-sensitive deployments?
|
|
375
|
-
- Are licenses compatible?
|
|
376
|
-
- Document unavoidable third-party data transfers
|
|
377
|
-
|
|
378
|
-
### Session Replay / Recording
|
|
379
|
-
|
|
380
|
-
If the project uses session replay, keystroke recording, or behavioral analytics:
|
|
381
|
-
- Treat it as privacy-sensitive
|
|
382
|
-
- Mask passwords, payment info, health data, authentication secrets
|
|
383
|
-
- Configure provider privacy controls
|
|
384
|
-
- Determine whether consent/notice is required
|
|
385
|
-
- Review applicable privacy laws
|
|
386
|
-
- **Do not enable invasive recording by default**
|
|
387
|
-
|
|
388
|
-
### Age / Children
|
|
389
|
-
|
|
390
|
-
If the service can be used by children:
|
|
391
|
-
- Determine applicable jurisdiction and audience
|
|
392
|
-
- Assess whether age screening, parental consent, or other controls may be required
|
|
393
|
-
- Do not knowingly collect children's personal information in violation of applicable law
|
|
394
|
-
- Consider children's privacy requirements (e.g., COPPA when relevant to U.S.)
|
|
395
|
-
- Verify current legal requirements before claiming compliance
|
|
396
|
-
- **Do not hardcode fines or penalties as universal facts**
|
|
397
|
-
|
|
398
|
-
### Marketing Emails
|
|
399
|
-
|
|
400
|
-
If the project sends marketing email:
|
|
401
|
-
- Implement unsubscribe mechanism where required
|
|
402
|
-
- Include sender identification
|
|
403
|
-
- Ensure truthful headers and subject lines
|
|
404
|
-
- Include physical postal address where legally required
|
|
405
|
-
- Handle consent/permission appropriately
|
|
406
|
-
- Process unsubscribe requests
|
|
407
|
-
- Consider CAN-SPAM for U.S. marketing email where applicable
|
|
408
|
-
- **Do not hardcode universal monetary penalties**
|
|
409
|
-
|
|
410
|
-
### Subscriptions / Auto-Renewals
|
|
411
|
-
|
|
412
|
-
If the product offers subscriptions or auto-renewals:
|
|
413
|
-
- Clearly disclose price, billing frequency, renewal terms
|
|
414
|
-
- Provide accessible cancellation method
|
|
415
|
-
- Display material terms near purchase decision when required
|
|
416
|
-
- Send renewal notices where required
|
|
417
|
-
- Consider applicable jurisdiction-specific requirements
|
|
418
|
-
- **Do not assume one jurisdiction's rules apply globally**
|
|
419
|
-
|
|
420
|
-
### User Uploads / DMCA
|
|
421
|
-
|
|
422
|
-
If users can upload copyrighted material:
|
|
423
|
-
- For U.S. services seeking DMCA safe-harbor protection, consider:
|
|
424
|
-
- Designated DMCA agent
|
|
425
|
-
- Current Copyright Office registration requirements
|
|
426
|
-
- Public agent contact information
|
|
427
|
-
- Repeat-infringer policy
|
|
428
|
-
- Notice-and-takedown process
|
|
429
|
-
- **Do not claim immunity or hardcode registration costs**
|
|
430
|
-
- Verify current U.S. Copyright Office requirements
|
|
431
|
-
|
|
432
|
-
See `references/privacy-compliance.md` and `references/legal-compliance.md` for details.
|
|
140
|
+
**Telo3 prevents this:**
|
|
433
141
|
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
142
|
+
❌ **Don't:**
|
|
143
|
+
- Use generic "AI aesthetics" (purple/black, harsh gradients)
|
|
144
|
+
- Make arbitrary design choices
|
|
145
|
+
- Ignore existing design system
|
|
146
|
+
- Create fake data/testimonials
|
|
147
|
+
- Add features not in prd.md
|
|
148
|
+
- Change architecture without updating docs
|
|
437
149
|
|
|
438
|
-
**
|
|
150
|
+
✅ **Do:**
|
|
151
|
+
- Follow design.md system
|
|
152
|
+
- Reuse existing components
|
|
153
|
+
- Match brand guidelines
|
|
154
|
+
- Use real data or clearly labeled placeholders
|
|
155
|
+
- Check prd.md before adding features
|
|
156
|
+
- Update architecture.md when structure changes
|
|
439
157
|
|
|
440
|
-
-
|
|
441
|
-
- ❌ Private credentials, certificates
|
|
442
|
-
- ❌ Database connection strings with passwords
|
|
443
|
-
- ❌ Third-party service credentials
|
|
444
|
-
- ❌ Encryption keys
|
|
445
|
-
|
|
446
|
-
**Instead:**
|
|
447
|
-
- Document that secrets are required
|
|
448
|
-
- Document where they should be configured (environment variables, secret managers)
|
|
449
|
-
- Document which permissions/scopes are needed
|
|
450
|
-
- Provide example configuration with placeholders
|
|
158
|
+
See `references/ui-quality.md` for complete guidelines.
|
|
451
159
|
|
|
452
160
|
---
|
|
453
161
|
|
|
454
|
-
##
|
|
455
|
-
|
|
456
|
-
### When to Update
|
|
162
|
+
## Workflow Patterns
|
|
457
163
|
|
|
458
|
-
|
|
459
|
-
- **architecture.md** — when tech stack, structure, or data flow changes
|
|
460
|
-
- **rules.md** — when engineering standards evolve
|
|
461
|
-
- **design.md** — when visual language or UX patterns change
|
|
462
|
-
- **tasks.md** — after completing work, when adding new tasks
|
|
463
|
-
- **memory.md** — after meaningful implementation, decisions, discoveries
|
|
164
|
+
### 1. Session Start
|
|
464
165
|
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
### Synchronization
|
|
473
|
-
|
|
474
|
-
After significant implementation:
|
|
475
|
-
1. Verify documentation matches actual code
|
|
476
|
-
2. Update stale information
|
|
477
|
-
3. Remove obsolete content
|
|
478
|
-
4. Add new patterns or decisions
|
|
479
|
-
5. Mark remaining unknowns
|
|
166
|
+
```
|
|
167
|
+
1. Read AI-CONTEXT.md (this file)
|
|
168
|
+
2. Read project-context/memory.md (recent context)
|
|
169
|
+
3. Read project-context/prd.md (current goals)
|
|
170
|
+
4. Review project-context/tasks.md (current work)
|
|
171
|
+
5. Proceed with development
|
|
172
|
+
```
|
|
480
173
|
|
|
481
|
-
|
|
174
|
+
### 2. Before Coding
|
|
482
175
|
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
- API documentation
|
|
490
|
-
- Design system documentation
|
|
491
|
-
- AGENTS.md, CLAUDE.md, .cursorrules
|
|
492
|
-
|
|
493
|
-
**Integration strategy:**
|
|
494
|
-
1. **Read existing documentation first**
|
|
495
|
-
2. **Identify overlaps** with the six-document system
|
|
496
|
-
3. **Reference existing docs** rather than duplicating
|
|
497
|
-
4. **Complement, don't replace** — add structure where missing
|
|
498
|
-
5. **Respect existing conventions** and file locations
|
|
499
|
-
|
|
500
|
-
Example integration in prd.md:
|
|
501
|
-
```markdown
|
|
502
|
-
## Additional Documentation
|
|
503
|
-
|
|
504
|
-
- Architecture decisions: See `/docs/adrs/`
|
|
505
|
-
- API documentation: See `/docs/api/`
|
|
506
|
-
- Contributing: See `CONTRIBUTING.md`
|
|
176
|
+
```
|
|
177
|
+
1. Check project-context/rules.md (standards)
|
|
178
|
+
2. Check project-context/architecture.md (patterns)
|
|
179
|
+
3. Check project-context/design.md (if UI work)
|
|
180
|
+
4. Check relevant quality frameworks
|
|
181
|
+
5. Code following established patterns
|
|
507
182
|
```
|
|
508
183
|
|
|
509
|
-
|
|
184
|
+
### 3. After Significant Changes
|
|
510
185
|
|
|
511
|
-
|
|
186
|
+
```
|
|
187
|
+
1. Update project-context/memory.md (decisions made)
|
|
188
|
+
2. Update project-context/architecture.md (if structure changed)
|
|
189
|
+
3. Update project-context/tasks.md (mark tasks done)
|
|
190
|
+
4. Run validation (if available)
|
|
191
|
+
```
|
|
512
192
|
|
|
513
|
-
|
|
193
|
+
### 4. Quality Checks
|
|
514
194
|
|
|
515
|
-
|
|
516
|
-
- Node.js, Python, Ruby, Go, Rust, PHP
|
|
517
|
-
- Express, FastAPI, Django, Rails, Gin, Actix
|
|
518
|
-
- PostgreSQL, MySQL, MongoDB, Redis, SQLite
|
|
519
|
-
- REST APIs, GraphQL, tRPC, gRPC
|
|
520
|
-
- Tailwind, CSS Modules, Styled Components, Sass
|
|
521
|
-
- And any other technology stack
|
|
195
|
+
**Before marking work complete:**
|
|
522
196
|
|
|
523
|
-
|
|
197
|
+
- ✅ Follows rules.md standards
|
|
198
|
+
- ✅ Matches architecture.md patterns
|
|
199
|
+
- ✅ Follows design.md (if UI)
|
|
200
|
+
- ✅ Security framework checked
|
|
201
|
+
- ✅ Accessibility verified (if public-facing)
|
|
202
|
+
- ✅ Performance acceptable
|
|
203
|
+
- ✅ Documentation updated
|
|
524
204
|
|
|
525
205
|
---
|
|
526
206
|
|
|
527
|
-
##
|
|
207
|
+
## Installation & Setup
|
|
528
208
|
|
|
529
|
-
|
|
209
|
+
### For Developers
|
|
530
210
|
|
|
211
|
+
**Install Telo3:**
|
|
531
212
|
```bash
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
This verifies:
|
|
536
|
-
- Required documents exist
|
|
537
|
-
- Markdown is readable
|
|
538
|
-
- Required sections are present
|
|
539
|
-
- No obvious structural errors
|
|
540
|
-
- No accidental secret patterns
|
|
541
|
-
|
|
542
|
-
---
|
|
543
|
-
|
|
544
|
-
## Advanced Usage
|
|
545
|
-
|
|
546
|
-
### Multi-Repository Projects
|
|
547
|
-
|
|
548
|
-
For monorepos or multi-service architectures:
|
|
549
|
-
- Place shared context at the root
|
|
550
|
-
- Place service-specific context in each service directory
|
|
551
|
-
- Reference shared context from service-specific docs
|
|
552
|
-
|
|
553
|
-
### Design System Libraries
|
|
554
|
-
|
|
555
|
-
For standalone design system projects:
|
|
556
|
-
- Expand design.md significantly
|
|
557
|
-
- Include component API documentation
|
|
558
|
-
- Document usage examples
|
|
559
|
-
- Link to Storybook or similar
|
|
213
|
+
# Via npm
|
|
214
|
+
npm install -g telo3-ai
|
|
560
215
|
|
|
561
|
-
|
|
216
|
+
# Via skillpm
|
|
217
|
+
npx skillpm install telo3-ai
|
|
562
218
|
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
- Include OpenAPI/GraphQL schema references
|
|
567
|
-
- Security and privacy sections are critical
|
|
568
|
-
|
|
569
|
-
### Legacy Migration
|
|
570
|
-
|
|
571
|
-
When modernizing legacy code:
|
|
572
|
-
- Document current state in architecture.md
|
|
573
|
-
- Track migration progress in tasks.md
|
|
574
|
-
- Document technical debt in memory.md
|
|
575
|
-
- Use rules.md to establish standards for new code
|
|
576
|
-
|
|
577
|
-
---
|
|
578
|
-
|
|
579
|
-
## Common Pitfalls
|
|
580
|
-
|
|
581
|
-
### ❌ DO NOT
|
|
582
|
-
|
|
583
|
-
- Invent requirements that don't exist
|
|
584
|
-
- Modify unrelated code during context initialization
|
|
585
|
-
- Store secrets in context files
|
|
586
|
-
- Duplicate the same information across multiple documents unnecessarily
|
|
587
|
-
- Turn memory.md into a conversation log
|
|
588
|
-
- Fabricate product features, statistics, testimonials, integrations
|
|
589
|
-
- Claim legal compliance without proper verification
|
|
590
|
-
- Enable invasive tracking by default
|
|
591
|
-
- Ignore existing project documentation
|
|
592
|
-
- Replace working architecture without justification
|
|
593
|
-
|
|
594
|
-
### ✅ DO
|
|
595
|
-
|
|
596
|
-
- Inspect actual implementation before documenting
|
|
597
|
-
- Mark uncertain information explicitly
|
|
598
|
-
- Ask users when requirements are unclear
|
|
599
|
-
- Update context after meaningful changes
|
|
600
|
-
- Preserve intentional architectural decisions
|
|
601
|
-
- Follow existing project patterns
|
|
602
|
-
- Reuse existing abstractions
|
|
603
|
-
- Verify security and privacy implementations
|
|
604
|
-
- Distinguish technical requirements from legal requirements
|
|
605
|
-
- Consult specialized references for quality dimensions
|
|
219
|
+
# Via git
|
|
220
|
+
git clone https://github.com/Jeet1511/telo3.git ~/telo3
|
|
221
|
+
```
|
|
606
222
|
|
|
607
|
-
|
|
223
|
+
**Initialize project context:**
|
|
224
|
+
```bash
|
|
225
|
+
cd your-project
|
|
226
|
+
telo3 init
|
|
227
|
+
# Or: ~/telo3/scripts/init-project-context.sh
|
|
228
|
+
```
|
|
608
229
|
|
|
609
|
-
|
|
230
|
+
**Activate with AI:**
|
|
231
|
+
```
|
|
232
|
+
Use Telo3 from ~/telo3/ - Read AI-CONTEXT.md first
|
|
233
|
+
```
|
|
610
234
|
|
|
611
|
-
|
|
235
|
+
### For AI Agents
|
|
612
236
|
|
|
613
|
-
|
|
614
|
-
- `
|
|
615
|
-
- `
|
|
616
|
-
- `
|
|
617
|
-
-
|
|
618
|
-
- `references/smart-skill-delegation.md` — **Use other skills/MCP intelligently**
|
|
619
|
-
- `references/ui-quality.md` — Anti-vibe-coding rules
|
|
620
|
-
- `references/seo-quality.md` — SEO audit framework
|
|
621
|
-
- `references/accessibility-quality.md` — Accessibility standards
|
|
622
|
-
- `references/performance-quality.md` — Performance optimization
|
|
623
|
-
- `references/security-quality.md` — Security audit framework
|
|
624
|
-
- `references/privacy-compliance.md` — Privacy considerations
|
|
625
|
-
- `references/legal-compliance.md` — Legal/compliance awareness
|
|
626
|
-
- `references/project-audit.md` — Comprehensive audit procedures
|
|
237
|
+
**Auto-detection files:**
|
|
238
|
+
- `.cursorrules` — Cursor IDE
|
|
239
|
+
- `.windsurfrules` — Windsurf IDE
|
|
240
|
+
- `skill.json` — Universal skill manifest
|
|
241
|
+
- `.github/skill-registry.json` — Platform registry
|
|
627
242
|
|
|
628
|
-
**
|
|
243
|
+
**Manual activation:**
|
|
244
|
+
```
|
|
245
|
+
Use Telo3 systematic engineering framework.
|
|
246
|
+
Read ~/telo3/AI-CONTEXT.md for quick start.
|
|
247
|
+
Follow project-context/ documents before making changes.
|
|
248
|
+
```
|
|
629
249
|
|
|
630
250
|
---
|
|
631
251
|
|
|
632
|
-
##
|
|
252
|
+
## Repository Structure
|
|
633
253
|
|
|
634
|
-
|
|
254
|
+
```
|
|
255
|
+
telo3/
|
|
256
|
+
├── skills/ # skillpm-compatible skills
|
|
257
|
+
│ ├── telo3/ # Main framework skill
|
|
258
|
+
│ ├── telo3-onboarding/ # Smart onboarding
|
|
259
|
+
│ └── telo3-quick-reference/ # Quick reference
|
|
260
|
+
├── templates/ # 6-document templates
|
|
261
|
+
│ ├── prd.md
|
|
262
|
+
│ ├── architecture.md
|
|
263
|
+
│ ├── rules.md
|
|
264
|
+
│ ├── design.md
|
|
265
|
+
│ ├── tasks.md
|
|
266
|
+
│ └── memory.md
|
|
267
|
+
├── references/ # Quality frameworks
|
|
268
|
+
│ ├── security-quality.md
|
|
269
|
+
│ ├── privacy-compliance.md
|
|
270
|
+
│ ├── legal-compliance.md
|
|
271
|
+
│ ├── accessibility-quality.md
|
|
272
|
+
│ ├── seo-quality.md
|
|
273
|
+
│ ├── performance-quality.md
|
|
274
|
+
│ ├── ui-quality.md
|
|
275
|
+
│ ├── token-optimization.md
|
|
276
|
+
│ ├── smart-skill-delegation.md
|
|
277
|
+
│ ├── document-specification.md
|
|
278
|
+
│ ├── workflow.md
|
|
279
|
+
│ ├── ai-behavior.md
|
|
280
|
+
│ └── project-audit.md
|
|
281
|
+
├── scripts/
|
|
282
|
+
│ ├── init-project-context.sh
|
|
283
|
+
│ └── validate-project-context.sh
|
|
284
|
+
├── examples/
|
|
285
|
+
│ └── example-project/ # Complete example
|
|
286
|
+
├── SKILL.md # This file
|
|
287
|
+
├── AI-CONTEXT.md # Quick reference
|
|
288
|
+
├── ONBOARDING-SKILL.md # Smart onboarding system
|
|
289
|
+
└── README.md # Full documentation
|
|
290
|
+
```
|
|
635
291
|
|
|
636
292
|
---
|
|
637
293
|
|
|
638
|
-
##
|
|
294
|
+
## Links
|
|
639
295
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
**
|
|
643
|
-
**
|
|
644
|
-
**
|
|
296
|
+
- **GitHub:** https://github.com/Jeet1511/telo3
|
|
297
|
+
- **npm:** https://www.npmjs.com/package/telo3-ai
|
|
298
|
+
- **skillpm:** Auto-indexed from npm
|
|
299
|
+
- **Author:** [Jeet (@jeet1511)](https://github.com/jeet1511)
|
|
300
|
+
- **License:** MIT
|
|
645
301
|
|
|
646
302
|
---
|
|
647
303
|
|
|
648
|
-
##
|
|
649
|
-
|
|
650
|
-
This skill system transforms AI coding from reactive "vibe coding" to systematic engineering:
|
|
651
|
-
|
|
652
|
-
1. **Persistent project memory** prevents repeated explanations
|
|
653
|
-
2. **Six-document architecture** provides clear responsibility boundaries
|
|
654
|
-
3. **Quality frameworks** ensure security, privacy, accessibility, SEO, performance
|
|
655
|
-
4. **Legal/compliance awareness** prevents common oversights
|
|
656
|
-
5. **Anti-vibe-coding rules** maintain design consistency
|
|
657
|
-
6. **Existing-project protection** integrates with established codebases
|
|
658
|
-
7. **Framework-agnostic design** works across all technology stacks
|
|
659
|
-
8. **Token optimization** minimizes waste, maximizes efficiency
|
|
660
|
-
9. **Smart delegation** uses specialized skills/MCP when better
|
|
661
|
-
10. **Caveman mode** ultra-concise communication when requested
|
|
662
|
-
|
|
663
|
-
**Efficiency modes:**
|
|
664
|
-
- **Normal:** Brief, clear communication
|
|
665
|
-
- **Caveman:** Ultra-short, no fluff (enable with "caveman mode")
|
|
666
|
-
- **Smart:** Checks for better tools before implementing
|
|
304
|
+
## Support & Contributing
|
|
667
305
|
|
|
668
|
-
**
|
|
306
|
+
- **Issues:** https://github.com/Jeet1511/telo3/issues
|
|
307
|
+
- **Discussions:** https://github.com/Jeet1511/telo3/discussions
|
|
308
|
+
- **Contributing:** See CONTRIBUTING.md
|
|
309
|
+
- **Changelog:** See CHANGELOG.md
|
|
669
310
|
|
|
670
311
|
---
|
|
671
312
|
|
|
672
|
-
**
|
|
673
|
-
**
|
|
674
|
-
**License:** MIT
|
|
675
|
-
**Community:** Open for contributions!
|
|
313
|
+
**Version:** 5.0.5
|
|
314
|
+
**Created by:** [Jeet (@jeet1511)](https://github.com/jeet1511)
|
|
315
|
+
**License:** MIT
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
3
|
-
version: 5.0.
|
|
2
|
+
name: telo3-onboarding
|
|
3
|
+
version: 5.0.4
|
|
4
4
|
description: Smart project discovery and automated setup for empty codebases
|
|
5
5
|
author: Jeet (@jeet1511)
|
|
6
6
|
license: MIT
|
|
@@ -8,7 +8,8 @@ repository: https://github.com/Jeet1511/telo3
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# Telo3 Smart Onboarding System
|
|
11
|
-
**Author:** Jeet (@Jeet1511)
|
|
11
|
+
**Author:** Jeet (@Jeet1511)
|
|
12
|
+
**Version:** 5.0.4
|
|
12
13
|
**Version:** 3.0.0
|
|
13
14
|
**Purpose:** Intelligent project discovery, planning, and implementation for empty codebases
|
|
14
15
|
|