Skip to content

docs: align README and API docs with current routing/spatial implementation #1

Description

@blackopsrepl

Problem

The documentation currently overstates or misstates some implementation details:

  • README says "R-Tree Spatial Indexing" but the code uses K-D trees.
  • README suggests A*/Dijkstra routing, but current public route calls pass a zero heuristic, which behaves like Dijkstra.
  • README promises "Full road-following geometries", while the main route APIs still snap to nearest nodes.

Why this matters

This creates user confusion and makes correctness/performance expectations unclear.

Scope

  • Update README feature list and API examples.
  • Clarify the difference between node-snapped and edge-snapped routing if both remain public.
  • Document current complexity honestly until the implementation changes.

Acceptance criteria

  • README terminology matches the implementation.
  • API docs explicitly describe which public methods are node-snapped vs edge-snapped.
  • Performance claims are accurate and non-ambiguous.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions