Skip to content

docs: redesign README around benchmark proof - #280

Merged
cyfyifanchen merged 13 commits into
mainfrom
docs/readme_github_banner
Aug 12, 2026
Merged

docs: redesign README around benchmark proof#280
cyfyifanchen merged 13 commits into
mainfrom
docs/readme_github_banner

Conversation

@cyfyifanchen

@cyfyifanchen cyfyifanchen commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Reframe the README around benchmark evidence, onboarding, Deep Research, and Tracing.
  • Restore the main branch's opening product capability overview before the benchmark evidence.
  • Keep the table of contents removed and place the native Markdown benchmark table directly after the introduction.
  • Remove outbound links from the three benchmark row labels while preserving the reported results and supporting context.
  • Synchronize the English and Chinese READMEs around the same structure, spacing, and Back to top section boundaries.
  • Place the GitHub User Content onboarding recording directly below the benchmark table in both READMEs, using the same bare attachment URL.
  • Reduce duplicate capability, gateway, status, and ecosystem copy while preserving concise architecture and command references.
  • Document current runtime behavior for the six-step onboarding flow, MiroThinker-backed research delivery, and local trace storage.

Type

  • Fix
  • Feature
  • Docs
  • CI / tooling
  • Refactor
  • Other

Verification

  • Relevant tests pass locally
  • Relevant lint / type checks pass locally
  • User-facing docs or screenshots are updated when needed

Commands and results:

  • .venv/bin/pre-commit run --files README.md README.zh-CN.md - passed all applicable hooks.
  • git diff --check origin/main...HEAD - passed.
  • make check-large-files - passed.
  • git merge-tree --write-tree HEAD origin/main - passed with no conflicts.
  • README structure assertions - passed: no table of contents, no benchmark-label links, and four matching Back to top boundaries in each language.
  • Confirmed both READMEs use the same 33378-byte GitHub User Content hero banner; benchmark evidence is native Markdown.
  • Confirmed the 1179517-byte onboarding MP4 round-trips from GitHub User Content with SHA-256 124024e6d64c23b3e314aa6136d9e0d922f57ded97a830a5c97cd1323cb2c57f and renders with controls below Benchmarks in both languages.
  • uv run pytest --tb=short -q - 6130 passed, 33 skipped, and one local Python 3.14 ANSI color assertion failed; the GitHub Python 3.12 unit job passed.

Risk

  • Security impact considered
  • Backward compatibility considered
  • Rollback path is clear for risky changes

This is a low-risk documentation-only change. Rollback requires reverting the README commits; externally hosted user-content assets can remain unreferenced without affecting repository size.

Related Issues

N/A

@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

README benchmark artwork (hosted through GitHub User Content):

Raven benchmark evidence: efficiency, self-evolution, and proactivity

@cyfyifanchen
cyfyifanchen force-pushed the docs/readme_github_banner branch from 972f9c2 to f16a83a Compare August 11, 2026 07:57
@cyfyifanchen cyfyifanchen changed the title docs: update README banner docs: redesign README around benchmark proof Aug 11, 2026
@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

Optimized README assets (WebP, hosted through GitHub User Content):

Banner: 33,378 bytes

Raven banner

Benchmark: 50,026 bytes

Raven benchmark results across efficiency, self-evolution, and proactivity

@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

Light benchmark variant for the README (WebP, 55,342 bytes, hosted through GitHub User Content):

Raven benchmark results across efficiency, self-evolution, and proactivity

@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

README welcome screen assets (optimized for GitHub User Content):

Raven terminal welcome screen in light theme Raven terminal welcome screen in dark theme

@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

README onboarding video (GitHub User Content, 553,353 bytes):

otty-raven-onboarding.mp4

@cyfyifanchen

Copy link
Copy Markdown
Collaborator Author

Updated README onboarding video (GitHub User Content, 1,179,517 bytes):

otty-raven-onboarding.mp4

@cyfyifanchen
cyfyifanchen marked this pull request as ready for review August 12, 2026 12:34
@cyfyifanchen
cyfyifanchen merged commit 94e4551 into main Aug 12, 2026
9 checks passed
@cyfyifanchen
cyfyifanchen deleted the docs/readme_github_banner branch August 12, 2026 13: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.

1 participant