Skip to content

docs: redesign README for developer onboarding - #56

Merged
aakbarpour merged 1 commit into
mainfrom
docs/55-readme-redesign
Aug 14, 2026
Merged

docs: redesign README for developer onboarding#56
aakbarpour merged 1 commit into
mainfrom
docs/55-readme-redesign

Conversation

@aakbarpour

Copy link
Copy Markdown
Owner

Summary

Rewrites README.md into a concise, developer-first introduction to Flect.

What changed

  • Leads with the problem, value proposition, and Codex Skill quick start.
  • Adds a Mermaid verification flow, integration comparison, verdict guide, trust/privacy summary, CLI reference, documentation map, status, and attribution.
  • Presents RETRACE research uplift with explicit third-party attribution; does not claim those results for Flect.
  • Removes the local 20/40-case benchmark narrative, fixture/test-seam details, long internal configuration/protocol material, and maintainer build/test content.
  • Keeps the change limited to README.md.

Validation

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets --all-features -- -D warnings
  • cargo test --workspace
  • Flect blind verifier + separate reconciliation judge: SAME / SHIP

Closes #55

@aakbarpour
aakbarpour merged commit 4480ce2 into main Aug 14, 2026
5 checks passed
@aakbarpour
aakbarpour deleted the docs/55-readme-redesign branch August 14, 2026 00:02
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.

docs: redesign README for developer onboarding and research evidence

1 participant