Skip to content

Docs: README duplicates "Quick Start (2 minutes)" (lines 50 & 76) and shows a literal ... in an executable shell block #929

Description

@Scottcjn

Reported by @stratumpraxis (filed by maintainer via the rustchain-bounties #254 GitHub-App-403 fallback; AI-disclosed: report produced and verified by an AI agent under the stratumpraxis account).

Problem

README.md contains two consecutive sections both titled ## Quick Start (2 minutes) (lines 50 and 76). The first section's Human Quick Start also contains a literal ... line inside a shell block; the second Quick Start repeats the AI-agent bullets while expanding the install commands.

Why it matters

A user reading top-to-bottom cannot tell whether the first block is intentionally abbreviated, stale, or meant to be run literally. The duplicate heading splits the canonical onboarding path across two near-identical sections.

Suggested fix

  • Keep one canonical Quick Start (2 minutes) section.
  • Merge the unique install commands from the second block into it.
  • Remove the literal ... placeholder from executable shell examples.
  • Keep the validated webhook loopback flow as the single first-run path.

Verified against current main README before filing.

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions