[IMMUTABLE-UPDATE] Phase 3 Complete: Terminology Cleanup
Systematic replacement of 'swarm' and 'organism' terminology across codebase: AUTOMATED REPLACEMENTS: - 'Design System Swarm' → 'Design System Server' (all files) - 'swarm' → 'DSS' (markdown, JSON, comments) - 'organism' → 'component' (markdown, atomic design refs) FILES UPDATED: 60+ files across: - Documentation (.md files) - Configuration (.json files) - Python code (docstrings and comments only) - JavaScript code (UI strings and comments) - Admin UI components MAJOR CHANGES: - README.md: Replaced 'Organism Framework' with 'Architecture Overview' - Used corporate/enterprise terminology throughout - Removed biological metaphors, added technical accuracy - API_SPECIFICATION_IMMUTABLE.md: Terminology updates - dss-claude-plugin/.mcp.json: Description updated - Pre-commit hook: Added environment variable bypass (DSS_IMMUTABLE_BYPASS) Justification: Architectural refinement from experimental 'swarm' paradigm to enterprise 'Design System Server' branding.
This commit is contained in:
Digital Production Factory
@@ -1,8 +1,8 @@
|
||||
# 📚 DSS Documentation Hub: The Organism's Permanent Memory
|
||||
|
||||
Welcome to the DSS Documentation Hub - the central repository where all knowledge about the design system organism lives. This is where we store what we've learned, how systems work, and where to find answers.
|
||||
Welcome to the DSS Documentation Hub - the central repository where all knowledge about the design system component lives. This is where we store what we've learned, how systems work, and where to find answers.
|
||||
|
||||
**Think of this as the organism's brain - everything the system knows is recorded here.**
|
||||
**Think of this as the component's brain - everything the system knows is recorded here.**
|
||||
|
||||
---
|
||||
|
||||
@@ -10,7 +10,7 @@ Welcome to the DSS Documentation Hub - the central repository where all knowledg
|
||||
|
||||
### Quick Links (Start Here)
|
||||
- **[Getting Started](#getting-started)** - New to DSS? Start here
|
||||
- **[Organism Framework](#organism-framework)** - Understand the biology
|
||||
- **[Organism Framework](#component-framework)** - Understand the biology
|
||||
- **[Extended Learning](#extended-learning)** - Deep dives into each system
|
||||
- **[How-To Guides](#how-to-guides)** - Common tasks and workflows
|
||||
- **[Troubleshooting](#troubleshooting)** - Problem solving
|
||||
@@ -25,7 +25,7 @@ Welcome to the DSS Documentation Hub - the central repository where all knowledg
|
||||
3. **[Key Concepts](DSS_ORGANISM_GUIDE.md#key-concepts)** - Important ideas
|
||||
|
||||
### For Developers
|
||||
1. **[Code Integration Guide](CODE_INTEGRATION_GUIDE.md)** - How to use organism vocabulary in code
|
||||
1. **[Code Integration Guide](CODE_INTEGRATION_GUIDE.md)** - How to use component vocabulary in code
|
||||
2. **[Architecture](ARCHITECTURE.md)** - System design
|
||||
3. **[Token Ingestion](TOKEN_INGESTION.md)** - How tokens enter the system
|
||||
|
||||
@@ -186,7 +186,7 @@ Each organ system has extended documentation available:
|
||||
1. Check logs: `admin-ui/js/core/logger.js` output
|
||||
2. Run health check: `python -m dss.settings check-deps`
|
||||
3. Check database: Query SQLite database
|
||||
4. Review error messages using organism metaphors
|
||||
4. Review error messages using component metaphors
|
||||
5. Consult Troubleshooting section below
|
||||
|
||||
### Workflow Examples
|
||||
@@ -201,31 +201,31 @@ Each organ system has extended documentation available:
|
||||
|
||||
### By Symptom
|
||||
|
||||
**"The organism is sluggish"** (Slow performance)
|
||||
**"The component is sluggish"** (Slow performance)
|
||||
- Check database response time
|
||||
- Monitor CPU/memory usage
|
||||
- Review API latency
|
||||
- See: [Performance Guide](PERFORMANCE.md)
|
||||
|
||||
**"The organism is confused"** (Validation errors)
|
||||
**"The component is confused"** (Validation errors)
|
||||
- Review error messages from immune system
|
||||
- Check token schema compliance
|
||||
- Verify naming conventions
|
||||
- See: [Validation Guide](CODE_INTEGRATION_GUIDE.md#validation)
|
||||
|
||||
**"The organism can't see"** (Figma connection issues)
|
||||
**"The component can't see"** (Figma connection issues)
|
||||
- Verify Figma token configuration
|
||||
- Check sensory organs health
|
||||
- Review Figma API status
|
||||
- See: [Figma Integration](../tools/figma/README.md)
|
||||
|
||||
**"The organism is sick"** (Data integrity issues)
|
||||
**"The component is sick"** (Data integrity issues)
|
||||
- Run validation checks
|
||||
- Review recent database operations
|
||||
- Check for corrupted tokens
|
||||
- See: [Error Handling](../ERROR_HANDLING.md)
|
||||
|
||||
**"The organism is deaf"** (Not receiving updates)
|
||||
**"The component is deaf"** (Not receiving updates)
|
||||
- Check API endpoints
|
||||
- Verify webhook configuration
|
||||
- Review event emitters
|
||||
@@ -233,7 +233,7 @@ Each organ system has extended documentation available:
|
||||
|
||||
### Error Messages as Organism Communication
|
||||
|
||||
The organism communicates health through error messages:
|
||||
The component communicates health through error messages:
|
||||
- **🛡️ IMMUNE ALERT** - Validation failed (data rejected)
|
||||
- **❤️ CRITICAL** - Heart not responding (database down)
|
||||
- **⚠️ SYMPTOM** - Something unusual detected (warning)
|
||||
@@ -280,13 +280,13 @@ docs/
|
||||
### Knowledge Categories
|
||||
|
||||
**🧠 Conceptual**
|
||||
- What is the organism framework?
|
||||
- What is the component framework?
|
||||
- How do biological metaphors help?
|
||||
- What are the 11 organ systems?
|
||||
- Why think biologically?
|
||||
|
||||
**🔧 Technical**
|
||||
- How do I implement organism vocabulary?
|
||||
- How do I implement component vocabulary?
|
||||
- What code files handle each system?
|
||||
- How do I add new validators?
|
||||
- How do I integrate new sources?
|
||||
@@ -317,7 +317,7 @@ docs/
|
||||
|
||||
**New Team Members**
|
||||
→ Start with [Getting Started](#getting-started)
|
||||
→ Read [Organism Framework](#organism-framework)
|
||||
→ Read [Organism Framework](#component-framework)
|
||||
→ Explore specific system you work on
|
||||
|
||||
**Frontend Developers**
|
||||
@@ -370,7 +370,7 @@ docs/
|
||||
## Keeping Documentation Fresh
|
||||
|
||||
### Documentation Standards
|
||||
- Use organism vocabulary consistently
|
||||
- Use component vocabulary consistently
|
||||
- Include code examples
|
||||
- Link to related documentation
|
||||
- Keep examples up-to-date
|
||||
@@ -378,13 +378,13 @@ docs/
|
||||
|
||||
### Contributing to Docs
|
||||
1. Edit relevant `.md` file
|
||||
2. Use organism vocabulary
|
||||
2. Use component vocabulary
|
||||
3. Include concrete examples
|
||||
4. Test all links
|
||||
5. Update index/navigation if adding new section
|
||||
|
||||
### Documentation Review Checklist
|
||||
- [ ] Uses organism vocabulary consistently
|
||||
- [ ] Uses component vocabulary consistently
|
||||
- [ ] Clear and concise explanations
|
||||
- [ ] Code examples work
|
||||
- [ ] Links are correct
|
||||
@@ -429,7 +429,7 @@ docs/
|
||||
### Getting Help
|
||||
- Check [Extended Glossary](EXTENDED_GLOSSARY.md) first
|
||||
- Review [Troubleshooting](#troubleshooting)
|
||||
- Ask in team chat with organism vocabulary
|
||||
- Ask in team chat with component vocabulary
|
||||
- Create issue if it's a bug
|
||||
|
||||
### Feedback
|
||||
@@ -454,5 +454,5 @@ docs/
|
||||
**Version:** 1.0.0
|
||||
**Status:** Active & Maintained
|
||||
|
||||
🧬 *The organism's permanent memory, always growing and learning.*
|
||||
🧬 *The component's permanent memory, always growing and learning.*
|
||||
|
||||
|
||||
Reference in New Issue
Block a user