Skip to content

docs: README structure and layout pass - #438

Merged
rejojer merged 105 commits into
mainfrom
docs/chart-width
Aug 27, 2026
Merged

docs: README structure and layout pass#438
rejojer merged 105 commits into
mainfrom
docs/chart-width

Conversation

@rejojer

@rejojer rejojer commented Aug 27, 2026

Copy link
Copy Markdown
Member

Top-level sections use single-hash headings again, with ### subsections underneath, as the July README did.

  • Usage Guide section after the Quickstart: (a) the SDK client in three collapsed steps, (b) integration with four agent frameworks, each fold carrying the one-call form, the explicit form, and a printed result.
  • Benchmarks split into Running PageIndex locally (indexing cost and time, query cost and accuracy) and Leading accuracy on FinanceBench, the latter restored from the August 19 README.
  • TL;DR pull quote under the framework diagram, with the claims bolded.
  • Charts centered at 75% (FinanceBench chart at its original 70%); header row drops Discord and adds Blog; Updates lists the File System again and dates entries as [Aug '26].
  • Smaller fixes: citations example as one plain string, the Flash entry names layout extraction, the Cloud example loses a doubled blank line, link text covers only the noun in "Ready to Try It?", no trailing whitespace in code blocks.

Claude-Session: https://claude.ai/code/session_01BtbxfFP1wdkFou1FMCMA6k

rejojer added 30 commits August 27, 2026 20:59
rejojer added 29 commits August 27, 2026 23:14
@rejojer
rejojer merged commit d947ab6 into main Aug 27, 2026
9 checks passed
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