feat: Sync latest templates from blackroad-sandbox
✨ Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Alexa Louise
404
templates/EMOJI-REFERENCE.md
Normal file
404
templates/EMOJI-REFERENCE.md
Normal file
@@ -0,0 +1,404 @@
|
||||
# 🧠 BlackRoad Emoji Dictionary v3
|
||||
|
||||
**127 Canonical Emojis as a Scripting Language**
|
||||
|
||||
---
|
||||
|
||||
## 📖 How to Use This Language
|
||||
|
||||
Every line/section in templates can be structured as:
|
||||
|
||||
```
|
||||
[CONTEXT] [ACTION / STATUS] Title
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
⛅️ 🚀 Deploy Cloudflare Workers
|
||||
💻 ▶️ Run Local Development Server
|
||||
🛣 ✅ System Status: All Green
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 1. Layout & Pointers (23)
|
||||
|
||||
**For structure, flow, and "look here"**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 👉 | Main pointer | Call out important line/choice |
|
||||
| ☞ | Secondary pointer | Subtle "see also" |
|
||||
| ➡️ | Next/forward | Move to next step |
|
||||
| ⬅️ | Back/previous | Rollback step, go back |
|
||||
| ⬆️ | Up/earlier | Reference section above |
|
||||
| ⬇️ | Down/later | Read below/next section |
|
||||
| ↗️ | Escalate/scale up | Resources increasing |
|
||||
| ↘️ | De-escalate/scale down | Reduce usage |
|
||||
| ↩️ | Return | Jump back to previous state |
|
||||
| ↪️ | Branch | Fork, alternate path |
|
||||
| ⤴️ | Promote | Promote staging → prod |
|
||||
| ⤵️ | Demote | Prod → staging/sandbox |
|
||||
| 🔀 | Re-route | Traffic switching, routing changes |
|
||||
| 🔁 | Loop/repeat | Repeat step/cron-like |
|
||||
| 🔂 | Repeat one | Re-run specific command |
|
||||
| ⏫ | Priority up | High-priority step |
|
||||
| ⏬ | Priority down | Low-priority/optional |
|
||||
| 🔼 | Increase | More replicas/higher limits |
|
||||
| 🔽 | Decrease | Fewer replicas/lower limits |
|
||||
| ➕ | Add | Create resource, add config line |
|
||||
| ➖ | Remove | Remove resource, subtract |
|
||||
| ✖️ | Multiply/explode | Fan-out, scale-wide |
|
||||
| 🫱 | Your turn | Human action required |
|
||||
|
||||
---
|
||||
|
||||
## 2. Context / Platform (17)
|
||||
|
||||
**Where/what this section is about**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| ⛅️ | Cloudflare | Workers, R2, D1, Wrangler |
|
||||
| ☁️ | Generic cloud | AWS, GCP, etc. |
|
||||
| 💻 | Dev machine/local | Local dev, CLI tooling |
|
||||
| 🛣 | BlackRoad OS | Cross-system/orchestration |
|
||||
| 📱 | Mobile | iOS/Android/TestFlight |
|
||||
| 🖥 | Web app | Dashboards, web frontends |
|
||||
| 🖱 | UI interaction | Clicking, dashboards, consoles |
|
||||
| ⌨️ | Typing/CLI | Terminal operations |
|
||||
| 🍎 | Apple ecosystem | macOS/iOS tools |
|
||||
| 💬 | Comms | Slack, Discord, Telegram |
|
||||
| 📓 | Productivity apps | Notion, Obsidian, Bear, Notes |
|
||||
| 🧰 | Utilities | 1Password, Stripe dashboard |
|
||||
| 📡 | Network/edge | Global edge network, routing mesh |
|
||||
| 🌐 | DNS/domains | Domains, subdomains, routing |
|
||||
| 💳 | Payments | Stripe, billing flows |
|
||||
| 🔐 | Security/auth | Secrets, auth, lock-down |
|
||||
| 🏠 | Home/root | Root project, main entrypoint |
|
||||
|
||||
---
|
||||
|
||||
## 3. Actions (17)
|
||||
|
||||
**Verbs/things happening**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 🚀 | Deploy/launch | Ship to environment |
|
||||
| ▶️ | Run | Run script/command/job |
|
||||
| ⏯ | Pause/resume | Toggle process, pause rollout |
|
||||
| ⏹ | Stop | Stop process/kill job |
|
||||
| ⏺ | Record | Start logging/tracing/recording |
|
||||
| 🔄 | Sync | Refresh state, pull latest configs |
|
||||
| ♻️ | Redeploy/recycle | Recreate with same config |
|
||||
| ⏮ | Step back | Previous release/state |
|
||||
| ⏭ | Step forward | Next release/step |
|
||||
| 📥 | Import | Ingest configs/data/DNS |
|
||||
| 📤 | Export | Backup, snapshot, archive |
|
||||
| 🧹 | Clean up | Remove temp artifacts, cache |
|
||||
| 🧽 | Deep clean | Aggressive cleanup |
|
||||
| 🔧 | Configure | Change config, settings |
|
||||
| 🪛 | Fix | Small targeted fix, patch |
|
||||
| 🗑 | Delete | Destructive operation (loud) |
|
||||
| 📌 | Pin | Mark something fixed/pinned/important |
|
||||
|
||||
---
|
||||
|
||||
## 4. Status / Severity (13)
|
||||
|
||||
**How things are going**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| ✅ | OK/done | Succeeded, safe, verified |
|
||||
| ☑️ | Done (checked) | Manual check item completed |
|
||||
| ☐ | Todo | Manual step remaining |
|
||||
| ⏳ | Pending/propagating | Waiting, in progress |
|
||||
| ⌛️ | Time-based waiting | TTL, timeouts, countdowns |
|
||||
| ⚠️ | Warning | Non-fatal, needs attention |
|
||||
| ❗️ | Important | Important note/must-read |
|
||||
| ❕ | Soft important | Lower-priority note |
|
||||
| ❌ | Error | Failed, stop here |
|
||||
| 🚫 | Forbidden | Not allowed/blocked |
|
||||
| 🚨 | Incident | On-fire, high severity |
|
||||
| 🔍 | Investigate | Look closer/drill in |
|
||||
| 🕵️ | Investigator | On-call/incident commander/root cause |
|
||||
|
||||
---
|
||||
|
||||
## 5. Resources & Infra (17)
|
||||
|
||||
**Things that exist in the system**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 📦 | Package/artifact | Worker script, bundle, container |
|
||||
| 📁 | Folder/repo | GitHub repo, directory |
|
||||
| 🗂 | Collection | Group of configs/projects |
|
||||
| 🗄 | Archive | Backups, cold storage |
|
||||
| 🧱 | Database/building block | D1 tables, infra blocks |
|
||||
| 🧬 | Config genetics | Feature flags, toggles, variants |
|
||||
| 🤖 | AI service/model | LLMs, agents, AI API |
|
||||
| 🛰 | Service/microservice | Satellite services |
|
||||
| 🧩 | Integration | Stripe, Clerk, 3rd-party piece |
|
||||
| 📜 | Schema/contract | API schema, DB schema, types |
|
||||
| 🗝 | Single key | API key, one credential |
|
||||
| 🔑 | Secrets store/vault | Env vars, secret manager |
|
||||
| 🎛 | Control panel | Feature flags, dashboards, toggles |
|
||||
| 🖧 | Network | VPC, mesh, routing layer |
|
||||
| 📑 | Generated doc | Machine output summary, report |
|
||||
| 🏗 | In-construction infra | Building infrastructure/migration |
|
||||
| 🏢 | Production estate | Full running environment/"the city" |
|
||||
|
||||
---
|
||||
|
||||
## 6. Docs & Learning (10)
|
||||
|
||||
**Words that explain what's happening**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 📚 | Reference docs | Full guides, manuals |
|
||||
| 📖 | Reading view | "Start here" explanations |
|
||||
| 📘 | API docs | Technical reference |
|
||||
| 📙 | How-to guide | Step-by-step walkthroughs |
|
||||
| 📕 | Policy/rules | Constraints, SLAs, guidelines |
|
||||
| 📝 | Notes/summary | Short summaries, quick notes |
|
||||
| 🗒 | Checklist | Deployment/verification checklist |
|
||||
| 📎 | Attachment | Linked file, external resource |
|
||||
| 🔖 | Bookmark | Crucial section/anchor |
|
||||
| 💡 | Tip/insight | Pro tips, best practice callouts |
|
||||
|
||||
---
|
||||
|
||||
## 7. People & Roles (10)
|
||||
|
||||
**Who is involved**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 👤 | Single user | One person, single account |
|
||||
| 👥 | Team | Group, squad, org |
|
||||
| 🧑💻 | Developer (generic) | Dev action required |
|
||||
| 👩💻 | Female dev | Person-specific |
|
||||
| 👨💻 | Male dev | Person-specific |
|
||||
| 🧑🏫 | Teacher/explainer | Tutorial mode, educational |
|
||||
| 🧑🔧 | Ops/SRE | Reliability/infra/ops owner |
|
||||
| 🤝 | Handoff/contract | Integration points, owner handoff |
|
||||
| 📣 | Stakeholder/announcer | Announcements, changelogs |
|
||||
| 🙋 | User action | "You need to do this now" |
|
||||
|
||||
---
|
||||
|
||||
## 8. Time & Scheduling (7)
|
||||
|
||||
**When things happen**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| ⏰ | Right now | Run immediately |
|
||||
| ⏱ | Duration | Timeouts, SLAs, latency |
|
||||
| 🕒 | Afternoon/mid-window | Generic time in diagram |
|
||||
| 🕕 | Evening/later window | Off-hours deployment |
|
||||
| 🕛 | Midnight/reset | Daily rollover/reset jobs |
|
||||
| 📆 | Schedule | Release trains, sprint calendars |
|
||||
| 🗓 | Specific date | Fixed deadlines, maintenance windows |
|
||||
|
||||
---
|
||||
|
||||
## 9. Observability & Debug (6)
|
||||
|
||||
**Seeing what the system is doing**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| 📊 | Metrics | Dashboards, graphs, SLO views |
|
||||
| 📈 | Upward trend | Performance/good metric going up |
|
||||
| 📉 | Downward trend | Drops, errors, regressions |
|
||||
| 🧾 | Logs | Log streams, tailing, text output |
|
||||
| 🔎 | Trace/inspect | Traces, deep inspection, span drilldown |
|
||||
| 🧯 | Mitigation | Fire extinguisher: mitigations, safety actions |
|
||||
|
||||
---
|
||||
|
||||
## 10. Meta / Vibe (7)
|
||||
|
||||
**The emotional layer/storytelling gloss**
|
||||
|
||||
| Emoji | Meaning | Usage |
|
||||
|-------|---------|-------|
|
||||
| ✨ | Magic/delightful | "This feels special" |
|
||||
| 🔥 | Epic done | Whole system wired, big milestone |
|
||||
| 💎 | Premium/enterprise value | "Worth $$" |
|
||||
| 🎉 | Celebration | Success, done, confetti |
|
||||
| 🧠 | Learning/brain mode | Philosophy, patterns, mental models |
|
||||
| 🔮 | Vision/future | Roadmap, speculative ideas |
|
||||
| 🦄 | Wild/experimental | Alpha, weird, unproven |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Template Integration Patterns
|
||||
|
||||
### Headers
|
||||
```
|
||||
⛅️🛣 BLACKROAD OS · CLOUDFLARE MAX BUILDOUT
|
||||
💻🔧 LOCAL DEVELOPMENT CONFIGURATION
|
||||
🖥💳 WEB APP · STRIPE INTEGRATION
|
||||
```
|
||||
|
||||
### Step Lists
|
||||
```
|
||||
1. 🚀 [ACT_DEPLOY] Deploy to production
|
||||
2. 🔄 [ACT_SYNC] Sync configurations
|
||||
3. 📥 [ACT_IMPORT] Import DNS records
|
||||
4. ✅ [STATUS_OK] Verify deployment
|
||||
```
|
||||
|
||||
### Status Boards
|
||||
```
|
||||
✅ 🧱 Database initialized
|
||||
⏳ 📦 Worker deployment pending
|
||||
✅ 🧩 Stripe integration active
|
||||
❌ 🛰 Agent service failed
|
||||
```
|
||||
|
||||
### Documentation Sections
|
||||
```
|
||||
📚 Documentation
|
||||
🗒 Deployment Checklist
|
||||
💡 Pro Tips
|
||||
🎯 Next Steps
|
||||
⚠️ Known Issues
|
||||
🔮 Future Roadmap
|
||||
```
|
||||
|
||||
### Service Status
|
||||
```
|
||||
⛅️ Cloudflare Workers ✅ 8 deployed
|
||||
🛣 Railway Services ✅ 20 running
|
||||
🖥 Vercel Projects ⏳ 3 deploying
|
||||
🧱 D1 Databases ✅ 6 initialized
|
||||
📦 R2 Buckets ✅ 12 configured
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Reference by Use Case
|
||||
|
||||
### Deployment Workflow
|
||||
```
|
||||
⛅️ 🚀 Deploy Cloudflare Worker
|
||||
💻 ⌨️ wrangler deploy blackroad-api.js
|
||||
⏳ Waiting for propagation...
|
||||
✅ Deployed to https://api.blackroad.io
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
```
|
||||
🚨 ❌ Deployment failed
|
||||
🔍 Investigating root cause
|
||||
🕵️ Checking worker logs
|
||||
🧯 Rolling back to previous version
|
||||
⏮ Restored to v1.2.3
|
||||
✅ Service recovered
|
||||
```
|
||||
|
||||
### Multi-Platform Status
|
||||
```
|
||||
⛅️ Cloudflare ✅ All systems operational
|
||||
🛣 Railway ⚠️ 1 service degraded
|
||||
🖥 Vercel ✅ All projects live
|
||||
📱 Mobile Apps ⏳ Build in progress
|
||||
🌐 DNS ✅ All records propagated
|
||||
```
|
||||
|
||||
### Documentation Structure
|
||||
```
|
||||
📖 Overview
|
||||
📘 API Reference
|
||||
📙 How-To Guides
|
||||
🗒 Deployment Checklist
|
||||
💡 Best Practices
|
||||
⚠️ Troubleshooting
|
||||
🔮 Roadmap
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Color-Coded Emoji Groups
|
||||
|
||||
### 🟢 Green (Success/Go)
|
||||
✅ ☑️ 🚀 💎 🎉
|
||||
|
||||
### 🟡 Yellow (Warning/Attention)
|
||||
⚠️ ❗️ ⏳ ⌛️ 🔍
|
||||
|
||||
### 🔴 Red (Error/Stop)
|
||||
❌ 🚫 🚨 🗑
|
||||
|
||||
### 🔵 Blue (Info/Context)
|
||||
ℹ️ 📚 📖 📘 💡
|
||||
|
||||
### 🟣 Purple (Special/Premium)
|
||||
✨ 🔮 🦄 💎
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Machine-Teachable Patterns
|
||||
|
||||
### Pattern 1: Status Check
|
||||
```
|
||||
[CONTEXT] [STATUS] Resource Name
|
||||
⛅️ ✅ Cloudflare Workers
|
||||
🛣 ⚠️ Railway API Service
|
||||
🖥 ❌ Vercel Dashboard
|
||||
```
|
||||
|
||||
### Pattern 2: Action Sequence
|
||||
```
|
||||
[STEP] [ACTION] [CONTEXT] Description
|
||||
1. 🚀 ⛅️ Deploy Workers
|
||||
2. 🔄 🧱 Sync Databases
|
||||
3. ✅ 🌐 Verify DNS
|
||||
```
|
||||
|
||||
### Pattern 3: Resource Inventory
|
||||
```
|
||||
[RESOURCE] [COUNT] [STATUS] Description
|
||||
📦 8 ✅ Workers deployed
|
||||
🧱 6 ✅ D1 databases initialized
|
||||
🗂 12 ✅ R2 buckets configured
|
||||
```
|
||||
|
||||
### Pattern 4: Troubleshooting Flow
|
||||
```
|
||||
🚨 [INCIDENT] Error detected
|
||||
🔍 [INVESTIGATE] Checking logs
|
||||
🕵️ [ROOT CAUSE] Found issue in config
|
||||
🪛 [FIX] Applied patch
|
||||
✅ [RESOLVED] Service restored
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Best Practices
|
||||
|
||||
1. **Consistency**: Use the same emoji for the same concept across all docs
|
||||
2. **Clarity**: Don't overload - 2-3 emojis max per line
|
||||
3. **Context First**: Lead with context emoji, then action/status
|
||||
4. **Machine-Readable**: Stick to the 127 canonical set
|
||||
5. **Visual Hierarchy**: Use emojis to create scannable structure
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
1. **Use in Templates**: All templates now use this emoji system
|
||||
2. **Train AI**: Claude/ChatGPT can learn these patterns
|
||||
3. **Consistency**: All docs follow same emoji language
|
||||
4. **Evolution**: Propose new emojis via PR with justification
|
||||
|
||||
---
|
||||
|
||||
**Remember**: These 127 emojis are on payroll. Use them consistently. 🧠💿🚀
|
||||
Reference in New Issue
Block a user