Skip to content

docs: align README and llms files with source behaviour - #26

Merged
TheCryptoDonkey merged 1 commit into
mainfrom
docs/audit-r3
Oct 18, 2026
Merged

TheCryptoDonkey merged 1 commit into
mainfrom
docs/audit-r3

Conversation

@TheCryptoDonkey

Copy link
Copy Markdown
Member

An audit of the published docs (README.md, llms.txt, AGENTS.md, package.json) raised high- and medium-severity gaps here. Each was checked against the source before the docs changed, and an independent review of the edited docs checked the result. No source or test files change.

Drop the drop-in ngeohash claim and document the real migration
differences (default precision, bboxes replacement, tie-break).
Document decode error, CoverageOptions and Nostr filter defaults,
polygon ring closure, [lon, lat] argument order, return types and
the midpoint and convexHull helpers. Link benchmark, Android and
schema docs by absolute URL as they are not in the npm tarball.
@TheCryptoDonkey
TheCryptoDonkey merged commit ae8232f into main Oct 18, 2026
2 checks passed
@TheCryptoDonkey
TheCryptoDonkey deleted the docs/audit-r3 branch October 18, 2026 20:34
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