Epic: Technical Guide Reorganization - Transform into Standards Library
Overview
Transform technical-guide from a mixed-purpose repository into a clean standards library (similar to OSSA).
Objectives
- Move operational services to logical homes (apidog-sync → agent-router, design-system-api → studio-ui)
- Decentralize OpenAPI specs to owning projects
- Migrate documentation to GitLab Wiki
- Establish as source of truth for design tokens and API governance
- Publish as @bluefly/technical-guide npm package
Success Criteria
-
✅ technical-guide <100MB (data/tokens only, no services) -
✅ Published as @bluefly/technical-guide npm package -
✅ All services running in correct projects -
✅ All OpenAPI specs in owning repositories -
✅ All documentation in GitLab Wiki -
✅ API registry accurately reflects distributed specs -
✅ All dependent projects updated and passing CI -
✅ No shell scripts (.sh files) in technical-guide -
✅ Brand validator works as CLI tool -
✅ API linting enforces standards across all projects
Architecture Principles
- API-First / OpenAPI 3.1
- TDD (tests before code)
- DRY (OpenAPI spec is single source of truth)
- CRUD (full lifecycle management)
- SOLID (thin controllers, logic in services)
- Type-Safe (Zod validation)
- NO SHELL SCRIPTS / MAKEFILES
Documentation
All engineering documentation lives in GitLab Wiki (not markdown files)
Related Issues
See linked child issues for specific implementation tasks.