Skip to content

Give the README a clearer technical story - #177

Merged
Astn merged 1 commit into
masterfrom
codex/readme-editorial
Sep 28, 2026
Merged

Astn merged 1 commit into
masterfrom
codex/readme-editorial

Conversation

@Astn

@Astn Astn commented Sep 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • Lead with a runnable JSON-RPC exchange, then explain the performance story from direct calls through async work, Kestrel and framework comparisons.
  • Keep the published benchmark tables, figures and measured numbers intact, with the conditions and comparison caveats beside their results.
  • Move detailed binding, hosting, error, session, configuration and security behavior into a new API reference page linked from the Overview and site navigation.
  • Render the README's expandable benchmark notes correctly on the Typst site and update cross-document links.

Verification

  • python benchmarks/charts/render.py --check
  • python -m unittest benchmarks/charts/test_render.py (43 tests)
  • python site/build.py --out site/_out
  • git diff --check

@Astn
Astn merged commit 950bf8f into master Sep 28, 2026
5 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