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

[galligan]

Summary

Adds comprehensive documentation to @outfitter/config package:

• README.md — Installation, quick start, full API reference, XDG path behavior table, override precedence diagram
• CHANGELOG.md — Initial 0.1.0 release notes
• TSDoc comments — All exported functions, types, and interfaces documented with @param, @returns, and @example

Highlights

• Documents XDG Base Directory Specification behavior across platforms
• Shows config precedence: flags > env > file > defaults
• Covers all supported formats: TOML, YAML, JSON, JSON5

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
• docs(config): add README, CHANGELOG, and TSDoc comments #35 👈 (View in Graphite)
• 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 package for @outfitter/config including README.md, CHANGELOG.md, and complete TSDoc comments for all exported functions
• Documentation covers XDG Base Directory Specification compliance, configuration precedence rules, and multi-format support (TOML, YAML, JSON, JSON5)

Important Files Changed

Filename	Overview
packages/config/src/index.ts	Enhanced with comprehensive TSDoc comments for all exported functions, types, and interfaces with examples
packages/config/README.md	New comprehensive documentation file covering API reference, XDG behavior, and configuration precedence

Confidence score: 5/5

• This PR is extremely safe to merge with no production risk as it only adds documentation
• Score reflects documentation-only changes with no functional code modifications that could introduce bugs or breaking changes
• No files require special attention as all changes are non-functional documentation enhancements

Sequence Diagram

sequenceDiagram
    participant User
    participant loadConfig
    participant getDefaultSearchPaths
    participant findConfigFile
    participant FileSystem
    participant parseConfigFile
    participant Parser
    participant Schema

    User->>loadConfig: "loadConfig(appName, schema, options?)"
    loadConfig->>getDefaultSearchPaths: "getDefaultSearchPaths(appName)"
    getDefaultSearchPaths-->>loadConfig: "searchPaths array"
    
    loop "for each search path"
        loadConfig->>findConfigFile: "findConfigFile(searchPath)"
        findConfigFile->>FileSystem: "existsSync(config.{ext})"
        FileSystem-->>findConfigFile: "file exists check"
        alt "file found"
            findConfigFile-->>loadConfig: "configFilePath"
        else "file not found"
            findConfigFile-->>loadConfig: "undefined"
        end
    end
    
    alt "config file found"
        loadConfig->>FileSystem: "readFileSync(configFilePath)"
        FileSystem-->>loadConfig: "file content"
        
        loadConfig->>parseConfigFile: "parseConfigFile(content, filename)"
        parseConfigFile->>Parser: "parse based on extension"
        Parser-->>parseConfigFile: "parsed object"
        parseConfigFile-->>loadConfig: "Result<object, ParseError>"
        
        loadConfig->>Schema: "schema.safeParse(parsed)"
        Schema-->>loadConfig: "validation result"
        loadConfig-->>User: "Result<T, ValidationError>"
    else "no config file found"
        loadConfig-->>User: "Result.err(NotFoundError)"
    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, 1:59 PM UTC: Graphite rebased this pull request as part of a merge.
• Jan 24, 2:00 PM UTC: @galligan merged this pull request with Graphite.