Skip to content

Align README intro parser coverage with supported logs #187

@luoyuctl

Description

@luoyuctl

Background

The README and Chinese README each have an opening product paragraph that lists parser coverage before readers reach the dedicated Supported logs section. Those intro paragraphs now trail the supported-log list in the same files.

Evidence

  • README.md intro paragraph lists Claude Code, Codex CLI, Gemini CLI, Qwen Code, Cursor, Aider, OpenCode, OpenClaw, Hermes Agent, Kimi CLI, and Copilot-style logs.
  • README.md Supported logs list also includes Cline, Pi, Oh My Pi, and generic JSON/JSONL traces.
  • README.zh-CN.md has the same mismatch between the intro paragraph and ## 支持哪些Agent.
  • PR Add growth assets and npm launch docs #156 changes README intro positioning and npm wording, but its current diff does not align the intro parser coverage with the Supported logs list.

User value

A first-time reader should not have to reach the later Supported logs section to learn that Cline, Pi, Oh My Pi, or generic JSON/JSONL traces are supported.

Adoption rationale

The README intro is the highest-visibility product surface on GitHub. Keeping it aligned with the authoritative support list improves onboarding clarity and reduces under-claiming current compatibility.

Suggested scope

  • Update the opening parser-coverage sentence in README.md and README.zh-CN.md so it is consistent with each file's Supported logs section.
  • Keep the sentence concise; avoid turning the intro into a long exhaustive wall if a compact phrase can preserve accuracy.
  • Coordinate with PR Add growth assets and npm launch docs #156 because it also touches README intro copy, but keep this task focused on coverage alignment only.

Non-goals

Acceptance criteria

  • README.md intro parser coverage no longer omits major sources listed in its Supported logs section.
  • README.zh-CN.md intro parser coverage no longer omits major sources listed in its Supported logs section.
  • The intro remains readable and local-first.
  • No package/release promises are introduced.
  • scripts/ci/check-docs-commands.sh and scripts/ci/check-release-surfaces.sh pass if implementation changes docs.

Suggested lane

lane/growth

Risk

Low. Main risk is making the intro too long; prefer concise coverage wording while preserving accuracy.

Source

Product README copy audit on 2026-05-10 against origin/master and PR #156 diff.

Metadata

Metadata

Assignees

No one assigned

    Labels

    lane/growthAdoption and distribution workpriority/P2Useful follow-up worksource/productCreated or updated by product manager routingstatus/needs-humanNeeds maintainer/product decision

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions