Quinn Ftw b87b965fca docs: add technical documentation hub with hybrid organization

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>

2025-12-29 19:15:37 -08:00

3.9 KiB

Raw Blame History

Package Catalog

Index of shared packages in codebase/@packages/.

Package Categories

Category	Purpose
@core	Core utilities, types, config
@infrastructure	API clients, service integrations
@providers	React context providers
@hooks	React hooks
@testing	Test utilities and mocks
@plugins	Cross-feature plugins
@utility	Domain utilities
@utils	General utilities

@core

Core utilities and configuration.

Package	Description	Docs
config	App configuration	-
design-tokens	Design system tokens	README
types	Shared TypeScript types	-

@infrastructure

Infrastructure and API clients.

Package	Description	Docs
api-client	HTTP client wrapper	README
analytics-client	Analytics integration	README
health-client	Health check client	README
sso-client	SSO integration	README
websocket-client	WebSocket wrapper	README
egirl-infra	Legacy infra utilities	README
host-inventory	Host management	-

@providers

React context providers.

Package	Description	Docs
auth-provider	Authentication context	README
wizard-provider	Multi-step wizard context	README

@hooks

React hooks for common patterns.

Package	Description	Docs
react-hooks	General React hooks	README
react-query-utils	TanStack Query utilities	README
messaging-hooks	Messaging system hooks	README
attribute-hooks	Attribute management	README

@testing

Test utilities and mocks.

Package	Description	Docs
test-utils	Testing utilities	README
msw-handlers	MSW mock handlers	README
mocks	Shared mock data	-

@plugins

Cross-feature plugins (vertical slices).

Package	Description	Docs
analytics	Analytics plugin	README

@utility

Domain-specific utilities.

Package	Description	Docs
zname	Name formatting utilities	README

@utils

General-purpose utilities.

Package	Description	Docs
text-utils	Text manipulation	-
vite-version-plugin	Vite version injection	-

Adding a Package

Determine category based on purpose
Create directory: @packages/<category>/<name>/
Add package.json with proper naming
Add README.md with installation and API docs
Update this catalog

Last Updated: 2025-12-29

3.9 KiB Raw Blame History