Skip to main content

Documentation Separation Guide

Overview​

This guide explains the clear separation of concerns between juniro-docs and juniro-design repositories to eliminate redundancy and improve maintainability.

🎯 Repository Purposes​

juniro-docs​

Focus: Strategic documentation, guidelines, and processes

Contains:

  • ✅ Business strategy and product roadmap
  • ✅ Engineering architecture and processes
  • ✅ Brand guidelines and accessibility standards
  • ✅ Implementation guides and best practices
  • ✅ Component status tracking
  • ✅ AI framework and prompt management
  • ✅ Team onboarding and operational procedures

juniro-design​

Focus: Interactive component library, implementation examples, and testing

Contains:

  • ✅ React component library with TypeScript
  • ✅ Interactive Storybook documentation
  • ✅ Design token implementation
  • ✅ Component testing (Jest, Playwright, Accessibility)
  • ✅ Live code examples and playground
  • ✅ Auto-generated API documentation

📋 Quick Reference​

Where to Put Documentation​

Type of DocumentationRepositoryExample
Business Strategyjuniro-docsProduct roadmap, financial overview
Process Guidelinesjuniro-docsDevelopment workflows, design processes
Brand Standardsjuniro-docsBrand guidelines, accessibility standards
Implementation Guidejuniro-docsHow to use the design system
Component Statusjuniro-docsImplementation tracking and progress
Component Libraryjuniro-designReact components with TypeScript
Interactive Examplesjuniro-designStorybook stories and playground
API Documentationjuniro-designAuto-generated from TypeScript
Design Tokensjuniro-designImplementation of design system tokens

Cross-Repository References​

From juniro-docs to juniro-design​

**🎨 View Component:** [Storybook Button Component](http://localhost:6006)
**📖 Full Documentation:** [Storybook Components](http://localhost:6006)
**🎯 Implementation Guide:** [How to use components](./implementation-guide.md)

From juniro-design to juniro-docs​

**📚 Brand Guidelines:** [View in juniro-docs](https://juniro-docs.vercel.app/design-system/brand-guidelines)
**♿ Accessibility Standards:** [View in juniro-docs](https://juniro-docs.vercel.app/design-system/accessibility)
**📋 Component Status:** [View in juniro-docs](https://juniro-docs.vercel.app/design-system/component-status)

🚀 Benefits​

✅ Eliminated Redundancy​

  • Single source of truth for each type of information
  • No duplicate maintenance between repositories
  • Consistent information across all sources

✅ Improved Developer Experience​

  • Interactive documentation in Storybook
  • Live examples and code playground
  • Auto-generated API docs from TypeScript
  • Built-in accessibility testing

✅ Better Maintenance​

  • One place to update each type of documentation
  • Automatic sync between code and documentation
  • Reduced documentation debt

✅ Clear Ownership​

  • juniro-docs: Strategy, guidelines, processes
  • juniro-design: Implementation, examples, testing

🔧 Implementation Guidelines​

When Adding New Documentation​

  1. Ask: "Is this strategic/process-oriented or implementation/example-oriented?"
  2. Strategic/Process: Add to juniro-docs
  3. Implementation/Example: Add to juniro-design
  4. Cross-reference: Use appropriate links between repositories

When Updating Existing Documentation​

  1. Check current location: Is it in the right repository?
  2. Update content: Make changes in the appropriate repository
  3. Update references: Ensure cross-repository links are current
  4. Verify consistency: Check that information is not duplicated

When Creating New Components​

  1. Implement: Add component to juniro-design
  2. Document: Create Storybook stories in juniro-design
  3. Track: Update component status in juniro-docs
  4. Reference: Add implementation guide in juniro-docs

📚 Related Documentation​

Last Updated: January 21, 2025
Maintained By: Engineering Team

📋 Current Repository Status​

Active Core Repositories​

  • ✅ juniro-docs - Strategic documentation, guidelines, and processes
  • ✅ juniro-design - Interactive component library and examples
  • ✅ juniro-platform - AI Agent Hub & Core Platform
  • ✅ juniro-repository-template - Standardized repository template

Application Repositories​

  • ✅ juniro-api - Backend API services
  • ✅ juniro-infra - Infrastructure as Code
  • ✅ juniro-web-parents - Parents marketplace
  • ✅ juniro-web-providers - Providers growth platform
  • ✅ juniro-web-admin - Admin interface
  • ✅ juniro-web-partners - Partners interface
  • ✅ juniro-web-public - Public website
  • ✅ juniro-mobile-android - Android mobile app
  • ✅ juniro-mobile-ios - iOS mobile app