docs: README restructure with quickstart, benchmarks, and a collapsed usage guide - #431
Merged
Conversation
…tart cross-links - Retrieve step and the comparison table say LLM reasoning again, and the 'Why it works' quote returns above the table - Model Recommendations use the quickstart's index=/chat= spellings; the usage guide notes the flat spellings are interchangeable - the own-agent integration block gets an anchor and the quickstart pointer links to it instead of claiming it lives in the Detailed Usage Guide - cloud table shows the managed chat included with the key; wait=True explained; em-dash spacing and heading whitespace
rejojer
added a commit
that referenced
this pull request
Aug 26, 2026
dash.pageindex.ai/api-keys now 307-redirects to developer.pageindex.ai/api-keys, and the README (PR #431) already standardized on the developer domain — the client docstring and the CloudClient keyless error message were the last SDK references to the old host.
Every prose em dash converts to a colon, comma, semicolon, or parentheses (label bullets take colons; parenthetical pairs become parentheses). The two table cells that use the dash as a not-available marker stay. Also: "flips to" becomes "goes straight to", and the Context table row gains "etc."
rejojer
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up on the README rewrite. Earlier snapshots of this branch already landed on main via #418/#419, so the Files view shows the whole rewrite. What this PR actually changes on top of main:
PageIndexClient(index=..., chat=...); Model Recommendations follow suit, and the Detailed Usage Guide notes the flatindex_model=/chat_model=spellings also work<cite/>output)assets/index-time-{light,dark}.pngPAGEINDEX_API_KEY+index="cloud"migration snippet, capability table with a Best-for row, and the managed chat (included with the key) visible againDocs-only:
README.md+ two images.https://claude.ai/code/session_01Tr1rUa2hjxSJZ41smfMaxu