Skip to content

Synchronize product documentation with current mainline capabilities #55

Description

@bearmug

Problem

The README and public landing page have drifted from the current product. The landing page still advertises 75+ metrics and 7 strategies, while mainline documents 100+ fields, 14 presets, strict preset files, search, metainfo, and TA ranking. The distinction between Claude Code commands and generic MCP-client functionality is also unclear.

Scope

  • Update repository README/API/development docs for current tool counts and preset-file behavior.
  • Document structured output, provenance, partial-result semantics, and upstream limitations after the implementation PRs land.
  • Remove stale examples and claims.
  • Open a linked cross-repository follow-up for fiale-plus.github.io landing-page synchronization.

Acceptance criteria

  • Repository docs match the actual tool list, defaults, operator value shapes, and CLI behavior.
  • Unofficial/public-endpoint limitations are visible at the point of setup.
  • No claim says 75+ metrics or 7 strategies.
  • Documentation references the supported MCP/CLI surfaces accurately.

Non-goals

No product feature expansion or redesign of the external website in this repository.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions