docs(ui): add README, CHANGELOG, and TSDoc comments

[galligan]

Summary

Adds comprehensive documentation to @outfitter/ui package:

• README.md — Installation, quick start, color tokens, output shapes, text formatting, terminal detection
• CHANGELOG.md — Initial 0.1.0 release notes
• TSDoc comments — All exported functions, types, and interfaces documented with @param, @returns, and @example

Highlights

• Documents semantic color tokens (success, warning, error, info)
• Shows NO_COLOR/FORCE_COLOR/TTY detection behavior
• Covers all output shapes: tables, lists, trees, progress bars
• Explains ANSI-aware text formatting (truncate, wrap, pad)

Test plan

• bun run typecheck passes
• bun run build succeeds

🤖 Generated with Claude Code

[galligan]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• chore(outfitter): sync templates on pack #108
• chore(changesets): ignore app package #107
• fix(errors): avoid TaggedError extends warnings #106
• chore(release): align package versions to 0.1.0 #105
• docs: add README and CHANGELOG for testing, kit, outfitter #95
• feat(templates): add daemon project template #94
• feat(templates): add MCP server project template #93
• feat(templates): add CLI project template #92
• fix(cli): implement confirmDestructive prompts #104
• fix(cli): implement createCLI and command builder #103
• feat(kit): add @outfitter/kit meta-package #91
• docs(daemon): add README and CHANGELOG #90
• fix(daemon): fix locking module bugs (GREEN phase) #89
• test(daemon): add locking module tests (RED phase) #88
• feat(daemon): add errors, platform, and locking module stubs #87
• feat(outfitter): add doctor command for environment validation #86
• feat(outfitter): add init command with project scaffolding #85
• feat(daemon): add IPC communication and health checks #84
• feat(daemon): add types and lifecycle management #83
• feat(index): add FTS5 full-text search implementation #82
• feat(index): add types for FTS5 full-text search #81
• feat(testing): add MCP and CLI test harnesses #80
• feat(testing): add test fixture utilities #79
• feat(mcp): add MCP server implementation with typed handlers #78
• feat(mcp): add types and interfaces for MCP server #77
• feat(ui): add Shape discriminated union and render() #76
• feat(ui): add createTokens semantic color layer #75
• feat(state): add pagination helpers #74
• feat(logging): add DEFAULT_PATTERNS for common secret redaction #73
• feat(ui): add formatRelative() for human-readable timestamps #72
• feat(state): add encodeCursor/decodeCursor for pagination #71
• feat(types): add hashId() for deterministic short identifiers #70
• feat(contracts): add Logger.child() and fix AssertionError category #69
• feat(config): centralize environment variable access with Zod validation #42
• fix(logging): enable redaction by default when global rules exist #41
• docs(ui): add README, CHANGELOG, and TSDoc comments #39 👈 (View in Graphite)
• docs(state): add README, CHANGELOG, and TSDoc comments #38
• docs(file-ops): add README, CHANGELOG, and TSDoc comments #37
• docs(logging): add README, CHANGELOG, and TSDoc comments #36
• docs(config): add README, CHANGELOG, and TSDoc comments #35
• fix(cli): enforce cursor TTL #114
• fix(tests): remove placeholder tests #113
• chore(gitattributes): prefer ours for bun lockfiles #115
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[greptile-apps]

Greptile Summary

• Adds comprehensive documentation to the @outfitter/ui package including README, CHANGELOG, and complete TSDoc comments for all exported functions and interfaces
• Provides detailed API documentation covering color tokens, output shapes (tables, lists, trees), text formatting utilities, and terminal detection capabilities
• Establishes proper documentation standards with usage examples and parameter descriptions following TypeScript documentation conventions

Important Files Changed

Filename	Overview
packages/ui/src/index.ts	Added comprehensive TSDoc documentation with @param, @returns, and @example annotations for all exported functions and interfaces

Confidence score: 5/5

• This PR is extremely safe to merge with no risk of production issues as it only adds documentation
• Score reflects that these are purely additive documentation changes with no behavioral modifications to the codebase
• No files require special attention as all changes are documentation-only and well-structured

Sequence Diagram

sequenceDiagram
    participant User
    participant createTheme
    participant supportsColor
    participant renderTable
    participant colorFn
    participant Terminal

    User->>createTheme: "createTheme()"
    createTheme->>supportsColor: "supportsColor()"
    supportsColor->>supportsColor: "Check NO_COLOR env"
    supportsColor->>supportsColor: "Check FORCE_COLOR env"
    supportsColor->>supportsColor: "Check process.stdout.isTTY"
    supportsColor-->>createTheme: "colorEnabled: boolean"
    createTheme->>colorFn: "Create color functions"
    createTheme-->>User: "Theme object"
    User->>Theme: "theme.success('Done!')"
    Theme-->>User: "Colored/plain text"
    User->>renderTable: "renderTable(data, options)"
    renderTable->>renderTable: "Calculate column widths"
    renderTable->>renderTable: "Build header and data rows"
    renderTable-->>User: "ASCII table string"
    User->>Terminal: "console.log(output)"

Loading