You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(readme): move the reference material into a published docs site #175
The README is the only documentation. It shows one request, and says nothing about the accepted input, the error responses, which providers answer, how the cache matches locations, the command-line flags or the metrics. Some of what it does say does not match the code:
README says
The code does
"The percision is limited to 3 decimal places"
Rounds the cache key to 3 decimal places, and sends 6 to the provider
One decimal place is ±10 km, three are ±100 m
One decimal place of latitude is a step of 11.1 km, and three are a step of 111 m
"found on [GitHub]"
Shows the brackets as text, because the link has no target
CONTRIBUTING.md points contributors at the README for interface changes, and names a tagging.yml workflow that does not exist.
Proposed Solution
Publish a docs site with MkDocs on Read the Docs, and cut the README to a description, a quick start and a table of pages.
Activity
github-actions commentedon Oct 13, 2026
👋 Hi and Thanks for Reporting!