Skip to content

docs(readme): move the reference material into a published docs site #175

Closed

Description

@saidsef

Problem Statement

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.

nav:
  - Overview: README.md
  - Installation: installation.md
  - Configuration: configuration.md
  - API: api.md
  - Architecture: architecture.md
  - Metrics: metrics.md

Affected Resources

  • README.md - cut down, with absolute links, because the chart release packages it
  • docs/ - new pages
  • mkdocs.yml and .readthedocs.yaml - new site and build configuration
  • CONTRIBUTING.md - the interface step and the versioning step
  • .gitignore - the MkDocs build output

Resource Links

Acceptance Criteria

  • Read the Docs builds the site from main.
  • Each page states only behaviour the code shows.
  • The README links work on GitHub and on Artifact Hub.
  • CONTRIBUTING.md names only files and workflows that exist.

Activity

  1. github-actions commented on Oct 13, 2026

    @github-actions

    👋 Hi and Thanks for Reporting!

  2. self-assigned this
    on Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions