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

[galligan]

Summary

Adds comprehensive documentation to @outfitter/logging package:

• README.md — Installation, quick start, log levels, redaction patterns, child loggers, formatters, sinks
• CHANGELOG.md — Initial 0.1.0 release notes
• TSDoc comments — All exported functions, types, and interfaces documented with @param, @returns, and @example

Highlights

• Documents log level hierarchy (trace → fatal → silent)
• Shows automatic redaction of sensitive keys (password, token, secret, apikey)
• Covers custom redaction patterns for API keys (OpenAI, GitHub PATs, Bearer tokens)
• Explains child logger context inheritance

Test plan

• bun run typecheck passes
• bun run build succeeds

🤖 Generated with Claude Code

[galligan]

• fix(errors): avoid TaggedError extends warnings #106 : 2 dependent PRs (#107 , #116 )
• 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
• 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 👈 (View in Graphite)
• 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/logging package including README, CHANGELOG, and TSDoc comments for all exported functions and types
• Establishes documentation standards with complete API reference, usage examples, and version history following Keep a Changelog format
• Documents key features like log level hierarchy, automatic sensitive data redaction, child logger context inheritance, and formatter/sink configurations

Important Files Changed

Filename	Overview
packages/logging/README.md	New comprehensive user documentation with installation guide, API examples, and complete feature coverage; potential API inconsistencies need verification
packages/logging/src/index.ts	Enhanced all exports with detailed TSDoc comments including parameter descriptions, return types, and usage examples

Confidence score: 3/5

• This PR contains mostly documentation changes with minimal risk to production functionality
• Score reflects potential API inconsistencies between documentation and actual implementation that need verification
• Pay close attention to packages/logging/README.md to ensure documented API matches the actual exported interface

Sequence Diagram

sequenceDiagram
    participant User
    participant Logger
    participant RedactionEngine
    participant Formatter
    participant Sink

    User->>Logger: "createLogger(config)"
    Logger->>Logger: "initialize internal state"
    User->>Logger: "logger.info(message, metadata)"
    Logger->>Logger: "shouldLog(level, minLevel)"
    Logger->>RedactionEngine: "processMetadata(metadata, redactionConfig)"
    RedactionEngine->>RedactionEngine: "redactValue(value, keys, patterns)"
    RedactionEngine-->>Logger: "processed metadata"
    Logger->>Logger: "create LogRecord"
    loop for each sink
        Logger->>Formatter: "format(record)"
        Formatter-->>Logger: "formatted string"
        Logger->>Sink: "write(record, formatted)"
        Sink->>Sink: "output to destination"
    end

Loading

[galligan]

Checked for new feedback; no changes needed. Stack still up to date.

[galligan]

Merge activity

• Jan 24, 1:54 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jan 24, 2:01 PM UTC: Graphite rebased this pull request as part of a merge.
• Jan 24, 2:02 PM UTC: @galligan merged this pull request with Graphite.