Skip to content

Fix outdated docs and shorten the README license section - #50

Merged
afarber merged 1 commit into
mainfrom
fix-doc-drift
Oct 13, 2026
Merged

afarber merged 1 commit into
mainfrom
fix-doc-drift

Conversation

@afarber

@afarber afarber commented Oct 13, 2026

Copy link
Copy Markdown
Owner

Went through the docs and compared them with the code. A fair amount had drifted:

  • The README and LIFECYCLE snippets called setZoom(14.0), which doesn't compile because the API takes a Float
  • The Example11 README still used MapType.NORMAL, TERRAIN and CYCLE, which no longer exist, and talked about five map types and clearing the cache. It's rewritten for the 15 current types. The app itself pointed to a docs/API_KEYS.md that doesn't exist; it now points to MAP_TYPES.md
  • MAP_TYPES said three types need an API key, but it's four. PUBLIC_API listed zoom as double
  • PERFORMANCE showed decode options the code doesn't set, cache hit rates nobody measured, and a benchmarking snippet using internal cache methods
  • The testing docs pinned versions that were already out of date (ktlint 1.3.1, robolectric 4.14). They now point to the version catalog. The instrumented test list was missing two of the four classes
  • The workflow docs still described OSSRH/JIRA accounts and closing the staging repo by hand. Both were shut down in 2025, and publishing now goes through the Central Portal automatically. The release checklist now uses publish-release.sh

The README license section said "Apache 2.0" six times in different ways, and repeated the MIT line again under Features. It's now one short paragraph.

- README: one short license paragraph instead of repeating Apache/MIT,
  setZoom() snippets now pass a Float, Example11 lists all map types
- Example11 README was still written for the old NORMAL/TERRAIN/CYCLE
  constants, rewrite it for the 15 current map types, and point the
  app's API key hint to MAP_TYPES.md (API_KEYS.md does not exist)
- PUBLIC_API, MAP_TYPES, LIFECYCLE: Float zoom, correct map type counts
- PERFORMANCE: match the real decode options, drop made-up cache hit
  rates and benchmarking calls to internal APIs
- Testing docs: no pinned versions (point to the version catalog),
  list all four instrumented test classes
- Publishing and workflow docs: Central Portal tokens instead of the
  shut down OSSRH/JIRA, release checklist uses publish-release.sh
@afarber
afarber merged commit f1fb74d into main Oct 13, 2026
14 checks passed
@afarber
afarber deleted the fix-doc-drift branch October 13, 2026 09: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