Name: glossary-sync-policy
Author: Zynapses

Prompt file imported from Zynapses/Radiant (.windsurf/workflows/glossary-sync-policy.md). Copyright stays with the author.

Glossary Synchronization Policy

⚠️ MANDATORY POLICY ⚠️

The RADIANT Glossary (docs/17-GLOSSARY.md) must be kept in sync with all other documentation.

When This Policy Applies

This policy is triggered when ANY of these documents are updated:

Document	Trigger Reason
`docs/01-THINK-TANK.md`	May introduce user-facing features, admin terms
`docs/02-CURATOR.md`	May introduce knowledge graph/verification terms
`docs/04-RADIANT-ADMIN.md`	May introduce platform terms/features
`docs/06-ARCHITECTURE-ENGINEERING.md`	May introduce technical terms/subsystems, architecture terms/AWS services
`docs/07-AI-SYSTEMS.md`	May introduce AI/brain/consciousness terms
`docs/09-OMEGA-GENESIS.md`	May introduce OMEGA/Genesis protocol terms
`docs/12-API-REFERENCE.md`	May introduce API/protocol terms
`docs/13-SECURITY-AUTH-COMPLIANCE.md`	May introduce security/auth terms
`docs/15-STRATEGY-COMPETITIVE.md`	May introduce competitive advantage terms
`docs/20-OMEGA-ENGINEERING.md`	May introduce OMEGA engineering terms
`docs/24-CARTRIDGE-SPECIALIZATIONS.md`	May introduce cartridge/specialization terms
`docs/25-PATENTS.md`	May introduce patent/IP strategy terms

Glossary Update Checklist

When updating any documentation, check for:

□ New AI/ML terms (LLM, RAG, LoRA, embedding, etc.)
□ New RADIANT subsystems (services, engines, pipelines)
□ New Think Tank features (UI features, user capabilities)
□ New AWS services being used
□ New acronyms or abbreviations
□ New database/storage terms
□ New security/compliance terms
□ New API/protocol terms
□ New UI/UX terms

How to Update the Glossary

Step 1: Identify New Terms

Search the updated document for:

Bold terms (**term**)
Technical jargon not in common use
Abbreviations and acronyms
Service or component names
AWS service references

Step 2: Add to Appropriate Section

The glossary has these sections:

Section	What Goes Here
1. OMEGA Protocol Terminology	OMEGA, Quantum Brain, Helix, Firmware, etc.
2. AI & Machine Learning Terms	LLM, RAG, embedding, inference, etc.
3. RADIANT Core Subsystems	Brain, Cato, Cortex, Genesis, etc.
4. Think Tank (Consumer AI Platform)	Magic Carpet, Polymorphic UI, etc.
5. RADIANT Applications	Curator, Dojo, Admin, Swift Deployer, etc.
6. Security & Intrusion Detection	RIDPS, Spend Governor, etc.
7. Operations & Monitoring	SENTINEL, Log Retention, Data Lake, etc.
8. AWS Services Used	Lambda, S3, Aurora, Bedrock, etc.
9. Acronyms & Abbreviations	All abbreviations (MCP, A2A, CBF, etc.)
10. Database & Storage Terms	pgvector, RDS Proxy, tiers, etc.
11. Security & Compliance Terms	RLS, RBAC, HIPAA, IP & Patents, etc.
12. API & Protocol Terms	MCP, A2A, SSE, WebSocket, etc.
13. UI/UX Terms	GenUI, Shadcn, Tailwind, etc.
14. Quick Reference Tables	Protocol summaries, streaming events, etc.

Step 3: Follow Table Format

| Term | Definition |
|------|------------|
| **New Term** | Clear, concise definition |

For subsystems with file references:

| Subsystem | Description | Key Files |
|-----------|-------------|-----------|
| **New System** | What it does | `path/to/file.ts` |

Step 4: Update Version

Update the version in the glossary header:

> **Version**: X.X.X | **Last Updated**: YYYY-MM-DD

Quick Reference: Term Categories

AI/ML Terms

Model types (LLM, transformer, embedding)
Training techniques (LoRA, RLHF, fine-tuning)
Inference concepts (temperature, tokens, RAG)

Subsystem Names

Core engines (Brain, Cato, Cortex, Genesis)
Feature systems (Grimoire, Time Machine, Flash Facts)
Safety systems (CBF, Truth Engine, Ethics Pipeline)

AWS Services

Compute (Lambda, SageMaker, ECS)
Database (Aurora, DynamoDB, ElastiCache)
Storage (S3, Glacier)
AI/ML (Bedrock, Textract, Comprehend)

Acronyms (ALWAYS add new ones)

Protocol acronyms (MCP, A2A, SSE)
RADIANT-specific (CBF, HITL, RAWS, UDS)
Compliance (HIPAA, SOC2, GDPR, CCPA)

Integration with Master Policy

This policy is integrated with docs-update-all.md:

When updating primary docs → Check glossary
When introducing new terms → Update glossary
When adding AWS services → Update glossary
When creating new subsystems → Update glossary

Regenerating PDF

After significant glossary updates, regenerate the PDF:

// turbo
pandoc docs/17-GLOSSARY.md -o docs/17-GLOSSARY.pdf \
  --pdf-engine=pdflatex \
  -V colorlinks=true \
  -V linkcolor=blue \
  -V urlcolor=blue \
  -V toccolor=blue \
  --toc --toc-depth=2 \
  -V geometry:margin=1in \
  -V fontsize=11pt

Anti-Patterns

❌ Adding new terms to docs without updating glossary ❌ Using undefined acronyms in documentation ❌ Introducing subsystems without glossary entries ❌ Adding AWS services without documenting in glossary ❌ Skipping glossary because "it's just a small change"

THIS POLICY IS MANDATORY. All new terms, subsystems, acronyms, and AWS services MUST be added to the glossary.

Install glossary-sync-policy and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

# Glossary Synchronization Policy > ⚠️ **MANDATORY POLICY** ⚠️ > > The RADIANT Glossary (`docs/17-GLOSSARY.md`) must be kept in sync with all other documentation. --- ## When This Policy Applies This policy is triggered when ANY of these documents are updated: | Document | Trigger Reason | |----------|---------------| | `docs/01-THINK-TANK.md` | May introduce user-facing features, admin terms | | `docs/02-CURATOR.md` | May introduce knowledge graph/verification terms | | `docs/04-RADIANT-ADMIN.md` | May introduce platform terms/features | | `docs/06-ARCHITECTURE-ENGINEERING.md` | May introduce technical terms/subsystems, architecture terms/AWS services | | `docs/07-AI-SYSTEMS.md` | May introduce AI/brain/consciousness terms | | `docs/09-OMEGA-GENESIS.md` | May introduce OMEGA/Genesis protocol terms | | `docs/12-API-REFERENCE.md` | May introduce API/protocol terms | | `docs/13-SECURITY-AUTH-COMPLIANCE.md` | May introduce security/auth terms | | `docs/15-STRATEGY-COMPETITIVE.md` | May introduce competitive advantage terms | | `docs/20-OMEGA-ENGINEERING.md` | May introduce OMEGA engineering terms | | `docs/24-CARTRIDGE-SPECIALIZATIONS.md` | May introduce cartridge/specialization terms | | `docs/25-PATENTS.md` | May introduce patent/IP strategy terms | --- ## Glossary Update Checklist When updating any documentation, check for: ``` □ New AI/ML terms (LLM, RAG, LoRA, embedding, etc.) □ New RADIANT subsystems (services, engines, pipelines) □ New Think Tank features (UI features, user capabilities) □ New AWS services being used □ New acronyms or abbreviations □ New database/storage terms □ New security/compliance terms □ New API/protocol terms □ New UI/UX terms ``` --- ## How to Update the Glossary ### Step 1: Identify New Terms Search the updated document for: - Bold terms (`**term**`) - Technical jargon not in common use - Abbreviations and acronyms - Service or component names - AWS service references ### Step 2: Add to Appropriate Section The glossary has these sections: | Section | What Goes Here | |---------|----------------| | 1. OMEGA Protocol Terminology | OMEGA, Quantum Brain, Helix, Firmware, etc. | | 2. AI & Machine Learning Terms | LLM, RAG, embedding, inference, etc. | | 3. RADIANT Core Subsystems | Brain, Cato, Cortex, Genesis, etc. | | 4. Think Tank (Consumer AI Platform) | Magic Carpet, Polymorphic UI, etc. | | 5. RADIANT Applications | Curator, Dojo, Admin, Swift Deployer, etc. | | 6. Security & Intrusion Detection | RIDPS, Spend Governor, etc. | | 7. Operations & Monitoring | SENTINEL, Log Retention, Data Lake, etc. | | 8. AWS Services Used | Lambda, S3, Aurora, Bedrock, etc. | | 9. Acronyms & Abbreviations | All abbreviations (MCP, A2A, CBF, etc.) | | 10. Database & Storage Terms | pgvector, RDS Proxy, tiers, etc. | | 11. Security & Compliance Terms | RLS, RBAC, HIPAA, IP & Patents, etc. | | 12. API & Protocol Terms | MCP, A2A, SSE, WebSocket, etc. | | 13. UI/UX Terms | GenUI, Shadcn, Tailwind, etc. | | 14. Quick Reference Tables | Protocol summaries, streaming events, etc. | ### Step 3: Follow Table Format ```markdown | Term | Definition | |------|------------| | **New Term** | Clear, concise definition | ``` For subsystems with file references: ```markdown | Subsystem | Description | Key Files | |-----------|-------------|-----------| | **New System** | What it does | `path/to/file.ts` | ``` ### Step 4: Update Version Update the version in the glossary header: ```markdown > **Version**: X.X.X | **Last Updated**: YYYY-MM-DD ``` --- ## Quick Reference: Term Categories ### AI/ML Terms - Model types (LLM, transformer, embedding) - Training techniques (LoRA, RLHF, fine-tuning) - Inference concepts (temperature, tokens, RAG) ### Subsystem Names - Core engines (Brain, Cato, Cortex, Genesis) - Feature systems (Grimoire, Time Machine, Flash Facts) - Safety systems (CBF, Truth Engine, Ethics Pipeline) ### AWS Services - Compute (Lambda, SageMaker, ECS) - Database (Aurora, DynamoDB, ElastiCache) - Storage (S3, Glacier) - AI/ML (Bedrock, Textract, Comprehend) ### Acronyms (ALWAYS add new ones) - Protocol acronyms (MCP, A2A, SSE) - RADIANT-specific (CBF, HITL, RAWS, UDS) - Compliance (HIPAA, SOC2, GDPR, CCPA) --- ## Integration with Master Policy This policy is integrated with `docs-update-all.md`: 1. When updating primary docs → Check glossary 2. When introducing new terms → Update glossary 3. When adding AWS services → Update glossary 4. When creating new subsystems → Update glossary --- ## Regenerating PDF After significant glossary updates, regenerate the PDF: ```bash // turbo pandoc docs/17-GLOSSARY.md -o docs/17-GLOSSARY.pdf \ --pdf-engine=pdflatex \ -V colorlinks=true \ -V linkcolor=blue \ -V urlcolor=blue \ -V toccolor=blue \ --toc --toc-depth=2 \ -V geometry:margin=1in \ -V fontsize=11pt ``` --- ## Anti-Patterns ❌ Adding new terms to docs without updating glossary ❌ Using undefined acronyms in documentation ❌ Introducing subsystems without glossary entries ❌ Adding AWS services without documenting in glossary ❌ Skipping glossary because "it's just a small change" --- **THIS POLICY IS MANDATORY. All new terms, subsystems, acronyms, and AWS services MUST be added to the glossary.**

{ "prompt": "# Glossary Synchronization Policy\n\n> ⚠️ **MANDATORY POLICY** ⚠️\n>\n> The RADIANT Glossary (`docs/17-GLOSSARY.md`) must be kept in sync with all other documentation.\n\n---\n\n## When This Policy Applies\n\nThis policy is triggered when ANY of these documents are updated:\n\n| Document | Trigger Reason |\n|----------|---------------|\n| `docs/01-THINK-TANK.md` | May introduce user-facing features, admin terms |\n| `docs/02-CURATOR.md` | May introduce knowledge graph/verification terms |\n| `docs/04-RADIANT-ADMIN.md` | May introduce platform terms/features |\n| `docs/06-ARCHITECTURE-ENGINEERING.md` | May introduce technical terms/subsystems, architecture terms/AWS services |\n| `docs/07-AI-SYSTEMS.md` | May introduce AI/brain/consciousness terms |\n| `docs/09-OMEGA-GENESIS.md` | May introduce OMEGA/Genesis protocol terms |\n| `docs/12-API-REFERENCE.md` | May introduce API/protocol terms |\n| `docs/13-SECURITY-AUTH-COMPLIANCE.md` | May introduce security/auth terms |\n| `docs/15-STRATEGY-COMPETITIVE.md` | May introduce competitive advantage terms |\n| `docs/20-OMEGA-ENGINEERING.md` | May introduce OMEGA engineering terms |\n| `docs/24-CARTRIDGE-SPECIALIZATIONS.md` | May introduce cartridge/specialization terms |\n| `docs/25-PATENTS.md` | May introduce patent/IP strategy terms |\n\n---\n\n## Glossary Update Checklist\n\nWhen updating any documentation, check for:\n\n```\n□ New AI/ML terms (LLM, RAG, LoRA, embedding, etc.)\n□ New RADIANT subsystems (services, engines, pipelines)\n□ New Think Tank features (UI features, user capabilities)\n□ New AWS services being used\n□ New acronyms or abbreviations\n□ New database/storage terms\n□ New security/compliance terms\n□ New API/protocol terms\n□ New UI/UX terms\n```\n\n---\n\n## How to Update the Glossary\n\n### Step 1: Identify New Terms\n\nSearch the updated document for:\n- Bold terms (`**term**`)\n- Technical jargon not in common use\n- Abbreviations and acronyms\n- Service or component names\n- AWS service references\n\n### Step 2: Add to Appropriate Section\n\nThe glossary has these sections:\n\n| Section | What Goes Here |\n|---------|----------------|\n| 1. OMEGA Protocol Terminology | OMEGA, Quantum Brain, Helix, Firmware, etc. |\n| 2. AI & Machine Learning Terms | LLM, RAG, embedding, inference, etc. |\n| 3. RADIANT Core Subsystems | Brain, Cato, Cortex, Genesis, etc. |\n| 4. Think Tank (Consumer AI Platform) | Magic Carpet, Polymorphic UI, etc. |\n| 5. RADIANT Applications | Curator, Dojo, Admin, Swift Deployer, etc. |\n| 6. Security & Intrusion Detection | RIDPS, Spend Governor, etc. |\n| 7. Operations & Monitoring | SENTINEL, Log Retention, Data Lake, etc. |\n| 8. AWS Services Used | Lambda, S3, Aurora, Bedrock, etc. |\n| 9. Acronyms & Abbreviations | All abbreviations (MCP, A2A, CBF, etc.) |\n| 10. Database & Storage Terms | pgvector, RDS Proxy, tiers, etc. |\n| 11. Security & Compliance Terms | RLS, RBAC, HIPAA, IP & Patents, etc. |\n| 12. API & Protocol Terms | MCP, A2A, SSE, WebSocket, etc. |\n| 13. UI/UX Terms | GenUI, Shadcn, Tailwind, etc. |\n| 14. Quick Reference Tables | Protocol summaries, streaming events, etc. |\n\n### Step 3: Follow Table Format\n\n```markdown\n| Term | Definition |\n|------|------------|\n| **New Term** | Clear, concise definition |\n```\n\nFor subsystems with file references:\n```markdown\n| Subsystem | Description | Key Files |\n|-----------|-------------|-----------|\n| **New System** | What it does | `path/to/file.ts` |\n```\n\n### Step 4: Update Version\n\nUpdate the version in the glossary header:\n```markdown\n> **Version**: X.X.X | **Last Updated**: YYYY-MM-DD\n```\n\n---\n\n## Quick Reference: Term Categories\n\n### AI/ML Terms\n- Model types (LLM, transformer, embedding)\n- Training techniques (LoRA, RLHF, fine-tuning)\n- Inference concepts (temperature, tokens, RAG)\n\n### Subsystem Names\n- Core engines (Brain, Cato, Cortex, Genesis)\n- Feature systems (Grimoire, Time Machine, Flash Facts)\n- Safety systems (CBF, Truth Engine, Ethics Pipeline)\n\n### AWS Services\n- Compute (Lambda, SageMaker, ECS)\n- Database (Aurora, DynamoDB, ElastiCache)\n- Storage (S3, Glacier)\n- AI/ML (Bedrock, Textract, Comprehend)\n\n### Acronyms (ALWAYS add new ones)\n- Protocol acronyms (MCP, A2A, SSE)\n- RADIANT-specific (CBF, HITL, RAWS, UDS)\n- Compliance (HIPAA, SOC2, GDPR, CCPA)\n\n---\n\n## Integration with Master Policy\n\nThis policy is integrated with `docs-update-all.md`:\n\n1. When updating primary docs → Check glossary\n2. When introducing new terms → Update glossary\n3. When adding AWS services → Update glossary\n4. When creating new subsystems → Update glossary\n\n---\n\n## Regenerating PDF\n\nAfter significant glossary updates, regenerate the PDF:\n\n```bash\n// turbo\npandoc docs/17-GLOSSARY.md -o docs/17-GLOSSARY.pdf \\\n --pdf-engine=pdflatex \\\n -V colorlinks=true \\\n -V linkcolor=blue \\\n -V urlcolor=blue \\\n -V toccolor=blue \\\n --toc --toc-depth=2 \\\n -V geometry:margin=1in \\\n -V fontsize=11pt\n```\n\n---\n\n## Anti-Patterns\n\n❌ Adding new terms to docs without updating glossary\n❌ Using undefined acronyms in documentation\n❌ Introducing subsystems without glossary entries\n❌ Adding AWS services without documenting in glossary\n❌ Skipping glossary because \"it's just a small change\"\n\n---\n\n**THIS POLICY IS MANDATORY. All new terms, subsystems, acronyms, and AWS services MUST be added to the glossary.**", "variables": [], "notes": "Policy - RADIANT Glossary must be synchronized when documentation changes introduce new terms", "metadata": { "source": { "provider": "github-windsurf-workflows", "repository": "https://github.com/Zynapses/Radiant", "path": ".windsurf/workflows/glossary-sync-policy.md", "ref": "dfcafdfbbf2191ee48921207c5c8a8ca77da957b", "url": "https://github.com/Zynapses/Radiant/blob/dfcafdfbbf2191ee48921207c5c8a8ca77da957b/.windsurf/workflows/glossary-sync-policy.md", "key": "Zynapses/Radiant/.windsurf/workflows/glossary-sync-policy.md" } } }

glossary-sync-policy

About