b87b965fca
Create overview docs in docs/technical/ and docs/research/ that link to colocated implementation docs throughout the codebase. New files: - INDEX.md: Central navigation hub by audience - technical/README.md: Technical documentation hub - technical/ARCHITECTURE.md: System architecture overview - technical/INFRASTRUCTURE.md: Infrastructure links - technical/PACKAGES.md: Package catalog (8 categories, 25+ packages) - technical/FEATURES.md: Feature catalog (16 features) - research/README.md: Research hub linking to business docs Strategy: Hybrid approach - conceptual docs in ./docs, implementation docs colocated with code they describe. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
131 lines
3.9 KiB
Markdown
131 lines
3.9 KiB
Markdown
# Package Catalog
|
|
|
|
Index of shared packages in `codebase/@packages/`.
|
|
|
|
---
|
|
|
|
## Package Categories
|
|
|
|
| Category | Purpose |
|
|
|----------|---------|
|
|
| [@core](#core) | Core utilities, types, config |
|
|
| [@infrastructure](#infrastructure) | API clients, service integrations |
|
|
| [@providers](#providers) | React context providers |
|
|
| [@hooks](#hooks) | React hooks |
|
|
| [@testing](#testing) | Test utilities and mocks |
|
|
| [@plugins](#plugins) | Cross-feature plugins |
|
|
| [@utility](#utility) | Domain utilities |
|
|
| [@utils](#utils) | General utilities |
|
|
|
|
---
|
|
|
|
## @core
|
|
|
|
Core utilities and configuration.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| config | App configuration | - |
|
|
| design-tokens | Design system tokens | [README](../../codebase/@packages/@core/design-tokens/README.md) |
|
|
| types | Shared TypeScript types | - |
|
|
|
|
---
|
|
|
|
## @infrastructure
|
|
|
|
Infrastructure and API clients.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| api-client | HTTP client wrapper | [README](../../codebase/@packages/@infrastructure/api-client/README.md) |
|
|
| analytics-client | Analytics integration | [README](../../codebase/@packages/@infrastructure/analytics-client/README.md) |
|
|
| health-client | Health check client | [README](../../codebase/@packages/@infrastructure/health-client/README.md) |
|
|
| sso-client | SSO integration | [README](../../codebase/@packages/@infrastructure/sso-client/README.md) |
|
|
| websocket-client | WebSocket wrapper | [README](../../codebase/@packages/@infrastructure/websocket-client/README.md) |
|
|
| egirl-infra | Legacy infra utilities | [README](../../codebase/@packages/@infrastructure/egirl-infra/README.md) |
|
|
| host-inventory | Host management | - |
|
|
|
|
---
|
|
|
|
## @providers
|
|
|
|
React context providers.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| auth-provider | Authentication context | [README](../../codebase/@packages/@providers/auth-provider/README.md) |
|
|
| wizard-provider | Multi-step wizard context | [README](../../codebase/@packages/@providers/wizard-provider/README.md) |
|
|
|
|
---
|
|
|
|
## @hooks
|
|
|
|
React hooks for common patterns.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| react-hooks | General React hooks | [README](../../codebase/@packages/@hooks/react-hooks/README.md) |
|
|
| react-query-utils | TanStack Query utilities | [README](../../codebase/@packages/@hooks/react-query-utils/README.md) |
|
|
| messaging-hooks | Messaging system hooks | [README](../../codebase/@packages/@hooks/messaging-hooks/README.md) |
|
|
| attribute-hooks | Attribute management | [README](../../codebase/@packages/@hooks/attribute-hooks/README.md) |
|
|
|
|
See also: [@hooks README](../../codebase/@packages/@hooks/README.md)
|
|
|
|
---
|
|
|
|
## @testing
|
|
|
|
Test utilities and mocks.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| test-utils | Testing utilities | [README](../../codebase/@packages/@testing/test-utils/README.md) |
|
|
| msw-handlers | MSW mock handlers | [README](../../codebase/@packages/@testing/msw-handlers/README.md) |
|
|
| mocks | Shared mock data | - |
|
|
|
|
---
|
|
|
|
## @plugins
|
|
|
|
Cross-feature plugins (vertical slices).
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| analytics | Analytics plugin | [README](../../codebase/@packages/@plugins/analytics/README.md) |
|
|
|
|
See also: [@plugins README](../../codebase/@packages/@plugins/README.md)
|
|
|
|
---
|
|
|
|
## @utility
|
|
|
|
Domain-specific utilities.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| zname | Name formatting utilities | [README](../../codebase/@packages/@utility/zname/README.md) |
|
|
|
|
---
|
|
|
|
## @utils
|
|
|
|
General-purpose utilities.
|
|
|
|
| Package | Description | Docs |
|
|
|---------|-------------|------|
|
|
| text-utils | Text manipulation | - |
|
|
| vite-version-plugin | Vite version injection | - |
|
|
|
|
---
|
|
|
|
## Adding a Package
|
|
|
|
1. Determine category based on purpose
|
|
2. Create directory: `@packages/<category>/<name>/`
|
|
3. Add `package.json` with proper naming
|
|
4. Add `README.md` with installation and API docs
|
|
5. Update this catalog
|
|
|
|
---
|
|
|
|
**Last Updated**: 2025-12-29
|