docs(http_client): add comprehensive timeout hierarchy documentation

[echobt]

Summary

Adds comprehensive documentation to the HTTP client timeout constants establishing naming conventions and hierarchy for timeout configuration across the codebase.

Problem

Timeout constants are scattered across multiple modules with inconsistent naming:

• Some use TIMEOUT, others use TIMEOUT_SECS
• Some use Duration type, others use u64
• Lack of central documentation about what each timeout controls

Changes

• Added detailed header documentation explaining the timeout hierarchy
• Documented each timeout constant with its purpose and use case
• Established naming conventions for constants vs config fields

Testing

• Verified code compiles with cargo check -p cortex-common

Verification

cargo check -p cortex-common

[greptile-apps]

Greptile Overview

Greptile Summary

This PR adds comprehensive documentation to the HTTP client timeout constants in src/cortex-common/src/http_client.rs. The changes are purely documentation improvements with no functional code changes.

Key Improvements:

• Added a detailed header section explaining the timeout hierarchy and categories (request, connection, read, pool timeouts)
• Documented naming conventions: constants use SCREAMING_SNAKE_CASE with Duration type, config fields use snake_case with _secs suffix for u64 values
• Enhanced each timeout constant's documentation with clearer descriptions of their purpose and use cases
• Positioned this module as the authoritative source for timeout configuration across the codebase

The documentation correctly describes the existing timeout values and their purposes. The PR addresses a legitimate maintenance concern about scattered timeout constants across the codebase (verified in files like api_client.rs and login/server.rs).

Confidence Score: 5/5

• This PR is completely safe to merge with zero risk
• Only documentation changes with no code modifications - improves maintainability and establishes clear conventions
• No files require special attention

Important Files Changed

Filename	Overview
src/cortex-common/src/http_client.rs	Added comprehensive timeout hierarchy documentation with clear naming conventions and usage guidelines

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Module as Other Module
    participant HC as http_client.rs
    participant Client as HTTP Client

    Note over HC: Timeout Constants Defined
    Note over HC: DEFAULT_TIMEOUT (30s)
    Note over HC: STREAMING_TIMEOUT (5m)
    Note over HC: HEALTH_CHECK_TIMEOUT (5s)
    Note over HC: POOL_IDLE_TIMEOUT (60s)

    Dev->>Module: Implement HTTP request
    Module->>HC: Import timeout constant
    HC-->>Module: Provides Duration constant
    Module->>HC: Call create_*_client()
    HC->>Client: Configure with timeout
    Client-->>Module: Returns configured client
    Module->>Client: Make HTTP request
    Client-->>Module: Response (within timeout)

Loading

[greptile-apps]

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[echobt]

Closing to consolidate: This timeout documentation will be merged with PR #49 into a consolidated documentation PR for timeout configuration.