Skip to content

docs(readme): drop internal project details from the README - #354

Merged
Zafnok merged 1 commit into
mainfrom
claude/readme-cleanup-9fbec5
Oct 3, 2026
Merged

Zafnok merged 1 commit into
mainfrom
claude/readme-cleanup-9fbec5

Conversation

@Zafnok

@Zafnok Zafnok commented Oct 3, 2026

Copy link
Copy Markdown
Owner

What changed

The README is what users land on, so this removes the internal material and regroups the rest.

Removed

  • Hosted (preview): the deploy/aca/ test deployment on Azure Container Apps (Bicep resources, free-grant maths, budget, deploy/run/teardown scripts). It is our own infrastructure, not something users run.
  • Status: milestone list, ticket ranges, corpus-run rates, spike results, and the open-work list (which also named the hosted tier).
  • "What exists today": a per-project component list (test generators, the lowering census, runtime-diff, tools/corpus/, .corpus/, quality-gate details).
  • ADR and ticket ids in the usage, MCP and requirements text.
  • Release internals (workflow file names, the .claude/skills/equiv-release pointer, image-size history).
  • Contributor-only material: "Read in this order" (CLAUDE.md, roadmap, tickets), the long Layout block, and the GitHub CLI and Docker Desktop prerequisites.

Added or regrouped

  • What it does: a short user-facing feature list in place of Status and the component list.
  • Installing (was "Running without cloning"), placed before Requirements (Windows and Linux, now about running equiv). The glibc note moved into the Linux list.
  • Building from source: build.ps1, the Z3 feed note, and a five-line layout.
  • Further reading: the verification model, architecture, quality gates and ADRs.

Unchanged: licence section, full usage, exit-code table, SARIF example, MCP section, badges.

For the reviewer

  • The old binary text said the single-file binary bundles "the SDK itself", which conflicts with the Linux section saying the .NET 10 SDK must be installed. It now just says the requirements still apply.
  • Not touched, but possibly worth removing too: the Sonar code-smell, lines-of-code, repo-size and commit-activity badges, and the docs/tickets/IOPERATION-COVERAGE.md link (the only remaining link into docs/tickets/).
  • No ticket: this is a docs-only change the user asked for directly.

🤖 Generated with Claude Code

The README is the landing page for users, but it carried internal
material: the Azure Container Apps test deployment, milestone and
ticket status, corpus-run rates, ADR and ticket ids in the usage text,
release workflow internals and contributor-only layout notes.

Replace the status and component list with a user-facing feature list,
regroup install, requirements and build-from-source, and keep usage,
exit codes, MCP and licence content unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Oct 3, 2026

Copy link
Copy Markdown

@Zafnok
Zafnok merged commit e56cffd into main Oct 3, 2026
20 checks passed
@Zafnok
Zafnok deleted the claude/readme-cleanup-9fbec5 branch October 3, 2026 02:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant