Skip to content

Clarify factual positioning and performance claims in README and related work #475

Description

@vjovanov

Discussion status

Scoped documentation proposal. Keep human-discussion until the owner resolves the open editorial choices and releases it for implementation. This ticket has no release or 1.0 dependency.

Outcome

A reader can tell what Grund checks and retrieves, how it fits beside link checkers and requirements-traceability tools, and what its performance numbers actually measure. The README links to a factual, maintainable explanation without promising unimplemented capabilities or presenting unlike workloads as a general speed comparison.

This consolidates the remaining work in RM-positioning and RM-positioning-trace-tools. They share the same reader, documentation surfaces, and evidence review; separate tickets would duplicate that work.

Already shipped; exclude from new work

At main df506acfae6d39169e7e2cdabd2327f669a21c3d:

  • README line 20 already contains the requested “Lychee is the link checker; grund is the intent checker” paragraph and says both belong in CI. Do not reimplement that milestone by adding another slogan block. Accuracy corrections to existing claims remain in scope.
  • The README already demonstrates section-level citations and the resolver's lead, brief, table-of-contents, and full-body modes. Reuse that explanation instead of repeating it.
  • docs/related-work/REL-traceability-tools.md already contains the comparison and primary-project links, delivered with Add a REL kind for related work: the ideas grund descends from and the tools beside it #384. The remaining work is to review and connect it, not create a parallel comparison document.
  • The instruction-count harness and recorded benchmark material already exist. This ticket adds no benchmark machinery, thresholds, measurements, or engine features.

Remaining scope

  1. Explain the performance evidence honestly. Add a short explanation beside the README throughput claim or its immediate supporting text, linking the local wall-clock report and instruction-count methodology. Distinguish the dated local throughput snapshot, the historical committed instruction-count snapshot, and current generated-fixture/base-branch CI comparisons. Resolve the report's contradictory “release-blocking meter” wording: the current architecture explicitly says the regression limits are not wired to fail the build. Describe instruction count as a repeatable workload-cost proxy with its binary/input/build assumptions; do not turn it into a universal latency guarantee or claim an active regression gate that is absent. Do not refresh numbers merely to complete this documentation task.
  2. Explain the traceability relationship through concrete reader tasks. Add a concise README entry pointing to the existing related-work document. Ground Grund's own claims in shipped section-addressed retrieval, citation validation, and supported checked constraints. Avoid generic assertions that every neighbouring tool serves only coverage reports or requires every clause to be a separate item. Verify any retained competitor claim against current primary documentation, recording the relevant source/version/date, or remove/qualify it when evidence is insufficient.
  3. Audit the existing comparison rather than require a marketing matrix. Prefer a short task-oriented explanation. Keep a table only where supported, consistently defined dimensions help a reader choose a tool; exact Grund flag spelling is not a neutral test of another tool's retrieval capability. Do not require six rows, creation years, checkmark rankings, or a copied table in the README. The related-work document is the detailed home.
  4. Align boundary claims with the actual contract. The roadmap's proposed blanket ban on schema-level custom checks is inconsistent with existing grounded chapter/citation rules. Explain the supported declarative constraints and the limits on arbitrary executable checks and severity customization precisely. Review references to non-goals; correct unsupported inferences without creating new product policy. v2 schema: enforce ordered fields, scalar values, closed shapes, and declaration forms #458 and After 1.0: express place citation and grounding constraints as grounded rule declarations #468 are open design work, not shipped capabilities and not prerequisites for this docs cleanup. If mentioned, distinguish their proposed future scope explicitly.
  5. Remove unsupported future parity promises from the touched positioning material. Do not retain the related-work table's promised gap-report capability or the roadmap-derived “coverage parity is one shipping milestone away” line. Any remaining coverage description must name the exact current query/report behavior and its limits. This does not authorize a gap-report feature, its implementation, or a replacement proposal.

Apply equivalent factual corrections to an existing landing page only if one is identified; creating a site is out of scope.

Acceptance criteria

  • README readers can follow one short path to the detailed comparison and benchmark evidence, without duplicate introductory copy.
  • Every new or retained competitor capability claim in the touched comparison has current primary-source support and a clear definition; uncertain assertions are qualified or removed.
  • Performance copy distinguishes measured workload, date/build assumptions, proxy versus elapsed time, and reporting versus enforced thresholds. It does not imply fair interchangeable workloads merely from a timing ratio.
  • The related-work document no longer promises gap/coverage parity or contradicts shipped checked-rule support. Proposed v2 work is never presented as already available.
  • Documentation links/citations point to the most specific supporting source and the documents agree with one another. No CLI, core, configuration, benchmark code, or release change is part of completion.

Sources

Open editorial decisions

  • Is concise prose plus the existing related-work link enough, or does a smaller evidence-backed table serve an identifiable reader decision?
  • Should the dated throughput badge remain with explicit context or be retired? No new benchmark run is required by this ticket.
  • Which unsupported historical comparison claims should be removed entirely rather than maintained with recurring verification?

No required competitor slogan, new non-goal, release date, or coverage-parity commitment is pre-approved here.

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

    documentationImprovements or additions to documentationpath:plannedA written plan, discussed on the ticket, before the fixusabilityTool led the reader wrong: wrong output, wrong message, or misleading name

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions