Skip to content

docs: readability pass on server docs - #18

Merged
everpcpc merged 2 commits into
mainfrom
docs/arena-max-note
Oct 3, 2026
Merged

everpcpc merged 2 commits into
mainfrom
docs/arena-max-note

Conversation

@everpcpc

@everpcpc everpcpc commented Oct 3, 2026 •

Copy link
Copy Markdown
Member

Docs readability pass.

  • enhancements/index.mdx: behavior-difference bullets rewritten as scannable one-liners (details stay in the config reference and sub-pages); includes the MALLOC_ARENA_MAX=1 trade-off note for tiny boxes.
  • limitations.mdx: the 576-char intro sentence split into scope-exclusion bullets.
  • search.mdx: the CJK-unigram problem/solution paragraphs broken into short ones; dropped the over-long t2s parenthetical.
  • configuration.mdx: the cache_size comment shortened to match.

pnpm lint:docs clean.

The behavior-difference bullets and a few paragraphs had grown into
unreadable walls. One idea per bullet now; details stay in the config
reference and sub-pages.
@everpcpc everpcpc changed the title docs: note MALLOC_ARENA_MAX=1 trade-off for tiny boxes docs: readability pass on server docs Oct 3, 2026
@everpcpc
everpcpc marked this pull request as ready for review October 3, 2026 04:59
@everpcpc
everpcpc merged commit 7f17088 into main Oct 3, 2026
1 check passed
@everpcpc
everpcpc deleted the docs/arena-max-note branch October 3, 2026 04:59
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