From 80acdbe6f6ba347aa34296390f80a82a8bdc707c Mon Sep 17 00:00:00 2001 From: justrouting Date: Wed, 7 Oct 2026 06:01:35 +0000 Subject: [PATCH 1/3] refine openapi --- api-reference/directions.mdx | 2 ++ api-reference/distance-matrix.mdx | 2 ++ api-reference/fleet-optimization.mdx | 2 ++ api-reference/geocode.mdx | 2 ++ api-reference/map-matching.mdx | 2 ++ api-reference/nearest.mdx | 2 ++ api-reference/trip.mdx | 2 ++ docs.json | 16 ++++++++-------- index.mdx | 2 +- openapi.json => openapi/openapi.json | 0 openapi.mdx => openapi/overview.md | 6 +++--- 11 files changed, 26 insertions(+), 12 deletions(-) rename openapi.json => openapi/openapi.json (100%) rename openapi.mdx => openapi/overview.md (92%) diff --git a/api-reference/directions.mdx b/api-reference/directions.mdx index cc9db39..d892b59 100644 --- a/api-reference/directions.mdx +++ b/api-reference/directions.mdx @@ -3,6 +3,8 @@ title: "Directions API" description: "Get road-following routes between coordinates — distance, duration, geometry, and turn-by-turn steps." --- +## Overview + Directions API returns the real road route between two points (or ordered waypoints): distance (meters), estimated duration (seconds), route geometry (polyline or GeoJSON), and optional turn-by-turn steps. diff --git a/api-reference/distance-matrix.mdx b/api-reference/distance-matrix.mdx index 38f5371..c6954f2 100644 --- a/api-reference/distance-matrix.mdx +++ b/api-reference/distance-matrix.mdx @@ -3,6 +3,8 @@ title: "Distance Matrix API" description: "Compute travel times and distances between many points in a single request." --- +## Overview + Distance Matrix API returns an N×N matrix of driving times (seconds) and distances (meters) in a single request, powered by the `table` service. Ideal for nearest-store lookup, dispatch, and batch route planning. diff --git a/api-reference/fleet-optimization.mdx b/api-reference/fleet-optimization.mdx index e242eb9..9b2b1db 100644 --- a/api-reference/fleet-optimization.mdx +++ b/api-reference/fleet-optimization.mdx @@ -3,6 +3,8 @@ title: "Fleet Optimization API" description: "Multi-vehicle route optimization powered by VROOM — assign jobs, sequence stops, respect time windows and capacity." --- +## Overview + Multi-vehicle route optimization (VRP) powered by [VROOM](https://github.com/VROOM-Project/vroom): you send JSON describing vehicles and tasks, you get back the optimal assignment and visit order. Distances come from the real OSRM road network — not straight lines. diff --git a/api-reference/geocode.mdx b/api-reference/geocode.mdx index ebdd582..efcd496 100644 --- a/api-reference/geocode.mdx +++ b/api-reference/geocode.mdx @@ -3,6 +3,8 @@ title: "Geocode API" description: "Convert a place name or address into coordinates — longitude, latitude, and address details." --- +## Overview + Geocode API converts a place name or address into coordinates. Send free-form text like `Marina Bay Sands, Singapore`, or a structured address with typed components; results come back ordered by relevance, each with `lon`/`lat` that plug directly into the `coordinates` of Directions and the other routing APIs. ## Endpoint diff --git a/api-reference/map-matching.mdx b/api-reference/map-matching.mdx index 60ba5b4..dc1b23c 100644 --- a/api-reference/map-matching.mdx +++ b/api-reference/map-matching.mdx @@ -3,6 +3,8 @@ title: "Map Matching API" description: "Snap noisy GPS traces to the real road network and get back the actual driven route." --- +## Overview + Map Matching API snaps a GPS trace to the real roads: send a timestamped coordinate sequence, get back the matched route (geometry, distance, duration) plus where each point landed on the network. Useful for cleaning delivery traces, analyzing actual driven paths, and mileage accounting. Powered by the OSRM Match service. diff --git a/api-reference/nearest.mdx b/api-reference/nearest.mdx index 6c5d140..4156ee2 100644 --- a/api-reference/nearest.mdx +++ b/api-reference/nearest.mdx @@ -3,6 +3,8 @@ title: "Nearest API" description: "Snap a coordinate to the road network and get the nearest routable segments." --- +## Overview + Nearest API snaps a single coordinate to the road network and returns the nearest `n` segments. Useful for validating whether a coordinate is routable, getting the exact snapped position, and obtaining `hint` values that speed up subsequent requests. Powered by the OSRM Nearest service. diff --git a/api-reference/trip.mdx b/api-reference/trip.mdx index cc289d0..d5e3fd1 100644 --- a/api-reference/trip.mdx +++ b/api-reference/trip.mdx @@ -3,6 +3,8 @@ title: "Trip API" description: "Solve the traveling salesman problem — find the fastest visiting order for many stops." --- +## Overview + Trip API solves the traveling salesman problem (TSP): given several stops, it returns an approximately optimal visiting order. Great for delivery route previews and multi-stop visit planning. Powered by the OSRM Trip service. diff --git a/docs.json b/docs.json index 447fc96..c65e2d8 100644 --- a/docs.json +++ b/docs.json @@ -50,14 +50,14 @@ "group": "OpenAPI", "icon": "terminal", "pages": [ - "openapi", - "openapi.json GET /route/v1/{profile}/{coordinates}", - "openapi.json GET /table/v1/{profile}/{coordinates}", - "openapi.json GET /match/v1/{profile}/{coordinates}", - "openapi.json GET /trip/v1/{profile}/{coordinates}", - "openapi.json GET /nearest/v1/{profile}/{coordinates}", - "openapi.json GET /geocode/v1/search", - "openapi.json POST /optimize" + "openapi/overview", + "openapi/openapi.json GET /route/v1/{profile}/{coordinates}", + "openapi/openapi.json GET /table/v1/{profile}/{coordinates}", + "openapi/openapi.json GET /match/v1/{profile}/{coordinates}", + "openapi/openapi.json GET /trip/v1/{profile}/{coordinates}", + "openapi/openapi.json GET /nearest/v1/{profile}/{coordinates}", + "openapi/openapi.json GET /geocode/v1/search", + "openapi/openapi.json POST /optimize" ] }, { diff --git a/index.mdx b/index.mdx index f9c93b8..6c20d30 100644 --- a/index.mdx +++ b/index.mdx @@ -102,7 +102,7 @@ Give an AI agent the ability to: Connect Claude, Cursor, and other MCP-compatible AI clients to JustRouting. - + Use the machine-readable API specification with code generators and AI coding tools. diff --git a/openapi.json b/openapi/openapi.json similarity index 100% rename from openapi.json rename to openapi/openapi.json diff --git a/openapi.mdx b/openapi/overview.md similarity index 92% rename from openapi.mdx rename to openapi/overview.md index 185729f..a704db6 100644 --- a/openapi.mdx +++ b/openapi/overview.md @@ -1,9 +1,9 @@ --- -title: "OpenAPI" +title: "Overview" description: "Machine-readable specification for the JustRouting API." --- -# Overview +# OpenAPI JustRouting provides an OpenAPI specification for developers and tools that want to discover and integrate the API programmatically. @@ -13,7 +13,7 @@ schemas, and response schemas. ## Specification -[Download openapi.json](https://raw.githubusercontent.com/justrouting/docs/main/openapi.json) +[Download openapi.json](https://raw.githubusercontent.com/justrouting/docs/main/openapi/openapi.json) Use the interactive API explorer below to try JustRouting endpoints directly from the documentation. From 53d4c1b06ac2e121b862ad8fbebb1a7083ab1ad8 Mon Sep 17 00:00:00 2001 From: justrouting Date: Wed, 7 Oct 2026 06:45:45 +0000 Subject: [PATCH 2/3] add icons --- api-reference/directions.mdx | 3 ++- api-reference/distance-matrix.mdx | 3 ++- api-reference/fleet-optimization.mdx | 3 ++- api-reference/geocode.mdx | 3 ++- api-reference/map-matching.mdx | 3 ++- api-reference/nearest.mdx | 3 ++- api-reference/trip.mdx | 3 ++- authentication.mdx | 1 + coverage.mdx | 1 + docs.json | 5 ----- errors.mdx | 1 + guides/draw-route-on-map.mdx | 1 + guides/sdks.mdx | 1 + guides/turn-by-turn.mdx | 1 + index.mdx | 3 ++- mcp/overview.mdx | 5 +++-- openapi/overview.md | 1 + quickstart.mdx | 1 + rate-limits.mdx | 1 + 19 files changed, 28 insertions(+), 15 deletions(-) diff --git a/api-reference/directions.mdx b/api-reference/directions.mdx index d892b59..a36324e 100644 --- a/api-reference/directions.mdx +++ b/api-reference/directions.mdx @@ -1,6 +1,7 @@ --- -title: "Directions API" +title: "Directions" description: "Get road-following routes between coordinates — distance, duration, geometry, and turn-by-turn steps." +icon: "route" --- ## Overview diff --git a/api-reference/distance-matrix.mdx b/api-reference/distance-matrix.mdx index c6954f2..86bb6fe 100644 --- a/api-reference/distance-matrix.mdx +++ b/api-reference/distance-matrix.mdx @@ -1,6 +1,7 @@ --- -title: "Distance Matrix API" +title: "Distance Matrix" description: "Compute travel times and distances between many points in a single request." +icon: "table" --- ## Overview diff --git a/api-reference/fleet-optimization.mdx b/api-reference/fleet-optimization.mdx index 9b2b1db..f3a4e83 100644 --- a/api-reference/fleet-optimization.mdx +++ b/api-reference/fleet-optimization.mdx @@ -1,6 +1,7 @@ --- -title: "Fleet Optimization API" +title: "Fleet Optimization" description: "Multi-vehicle route optimization powered by VROOM — assign jobs, sequence stops, respect time windows and capacity." +icon: "truck" --- ## Overview diff --git a/api-reference/geocode.mdx b/api-reference/geocode.mdx index efcd496..6a445db 100644 --- a/api-reference/geocode.mdx +++ b/api-reference/geocode.mdx @@ -1,6 +1,7 @@ --- -title: "Geocode API" +title: "Geocode" description: "Convert a place name or address into coordinates — longitude, latitude, and address details." +icon: "search" --- ## Overview diff --git a/api-reference/map-matching.mdx b/api-reference/map-matching.mdx index dc1b23c..2ba7d77 100644 --- a/api-reference/map-matching.mdx +++ b/api-reference/map-matching.mdx @@ -1,6 +1,7 @@ --- -title: "Map Matching API" +title: "Map Matching" description: "Snap noisy GPS traces to the real road network and get back the actual driven route." +icon: "crosshairs" --- ## Overview diff --git a/api-reference/nearest.mdx b/api-reference/nearest.mdx index 4156ee2..e4e0d8e 100644 --- a/api-reference/nearest.mdx +++ b/api-reference/nearest.mdx @@ -1,6 +1,7 @@ --- -title: "Nearest API" +title: "Nearest" description: "Snap a coordinate to the road network and get the nearest routable segments." +icon: "map-pin" --- ## Overview diff --git a/api-reference/trip.mdx b/api-reference/trip.mdx index d5e3fd1..96ab20b 100644 --- a/api-reference/trip.mdx +++ b/api-reference/trip.mdx @@ -1,6 +1,7 @@ --- -title: "Trip API" +title: "Trip" description: "Solve the traveling salesman problem — find the fastest visiting order for many stops." +icon: "shuffle" --- ## Overview diff --git a/authentication.mdx b/authentication.mdx index 6afcacc..18b270e 100644 --- a/authentication.mdx +++ b/authentication.mdx @@ -1,6 +1,7 @@ --- title: "Authentication" description: "How API keys work in JustRouting — creating keys, sending them, and understanding authentication errors." +icon: "lock" --- Every JustRouting API request requires an API key, sent as an HTTP Bearer header: diff --git a/coverage.mdx b/coverage.mdx index c06fbaf..509b4df 100644 --- a/coverage.mdx +++ b/coverage.mdx @@ -1,6 +1,7 @@ --- title: "Coverage" description: "Which countries JustRouting covers, the cross-country constraint, and how map data updates work." +icon: "map" --- ## Covered countries diff --git a/docs.json b/docs.json index c65e2d8..9f9a182 100644 --- a/docs.json +++ b/docs.json @@ -16,7 +16,6 @@ "groups": [ { "group": "Getting Started", - "icon": "rocket", "pages": [ "index", "quickstart", @@ -28,7 +27,6 @@ }, { "group": "API Reference", - "icon": "code", "pages": [ "api-reference/directions", "api-reference/distance-matrix", @@ -41,14 +39,12 @@ }, { "group": "MCP", - "icon": "sparkles", "pages": [ "mcp/overview" ] }, { "group": "OpenAPI", - "icon": "terminal", "pages": [ "openapi/overview", "openapi/openapi.json GET /route/v1/{profile}/{coordinates}", @@ -62,7 +58,6 @@ }, { "group": "Guides", - "icon": "book-open", "pages": [ "guides/draw-route-on-map", "guides/turn-by-turn", diff --git a/errors.mdx b/errors.mdx index 4461185..9a31e7d 100644 --- a/errors.mdx +++ b/errors.mdx @@ -1,6 +1,7 @@ --- title: "Errors" description: "Error format, HTTP status codes, and the complete error code reference for JustRouting APIs." +icon: "triangle-exclamation" --- ## Error response format diff --git a/guides/draw-route-on-map.mdx b/guides/draw-route-on-map.mdx index af23e4f..683c49e 100644 --- a/guides/draw-route-on-map.mdx +++ b/guides/draw-route-on-map.mdx @@ -1,6 +1,7 @@ --- title: "Draw a Route on a Map" description: "Render JustRouting route geometry with Leaflet, Mapbox GL JS, or react-leaflet." +icon: "pen" --- Drawing a route on a map takes three steps: request `geometries=geojson`, grab `routes[0].geometry`, hand it to your map library. No polyline decoding needed. diff --git a/guides/sdks.mdx b/guides/sdks.mdx index 4188150..5f6dfab 100644 --- a/guides/sdks.mdx +++ b/guides/sdks.mdx @@ -1,6 +1,7 @@ --- title: "SDKs" description: "Official JustRouting client libraries for Python, JavaScript/TypeScript, and Go — zero dependencies." +icon: "cube" --- SDKs are official clients, all **zero third-party dependencies** and open source (MIT). They cover the three API families — Directions, Distance Matrix, Fleet Optimization — with typed errors and built-in 429 retries. diff --git a/guides/turn-by-turn.mdx b/guides/turn-by-turn.mdx index c8b8a2c..0070f60 100644 --- a/guides/turn-by-turn.mdx +++ b/guides/turn-by-turn.mdx @@ -1,6 +1,7 @@ --- title: "Turn-by-Turn Navigation" description: "Extract maneuver instructions from route steps to build navigation UI." +icon: "arrow-turn-right" --- Request `steps=true` and every entry in `legs[].steps[]` is one maneuver plus a stretch of straight-line driving. Use them to build navigation lists, voice prompts, or per-segment highlighting. diff --git a/index.mdx b/index.mdx index 6c20d30..383de18 100644 --- a/index.mdx +++ b/index.mdx @@ -1,6 +1,7 @@ --- title: "JustRouting Docs" description: "Routing APIs for Southeast Asia — directions, geocoding, distance matrices, map matching, and fleet optimization, with car and motorcycle profiles." +icon: "house" --- # JustRouting APIs for Southeast Asia @@ -43,7 +44,7 @@ Start in 30 seconds. **$0 to try.** No DevOps, no sales calls, no enterprise con ## Advanced APIs - + Match noisy GPS traces to the road network and recover realistic road paths. diff --git a/mcp/overview.mdx b/mcp/overview.mdx index 460795a..7071eab 100644 --- a/mcp/overview.mdx +++ b/mcp/overview.mdx @@ -1,6 +1,7 @@ --- -title: MCP -description: Give AI assistants access to JustRouting's routing, geocoding, distance matrix, and vehicle routing capabilities. +title: "MCP" +description: "Give AI assistants access to JustRouting's routing, geocoding, distance matrix, and vehicle routing capabilities." +icon: "sparkles" --- JustRouting MCP lets AI assistants such as Claude and Cursor use [JustRouting](https://justrouting.tech/) for road routing, geocoding, distance and travel-time comparison, and multi-vehicle route optimization. diff --git a/openapi/overview.md b/openapi/overview.md index a704db6..55a5e9e 100644 --- a/openapi/overview.md +++ b/openapi/overview.md @@ -1,6 +1,7 @@ --- title: "Overview" description: "Machine-readable specification for the JustRouting API." +icon: "globe" --- # OpenAPI diff --git a/quickstart.mdx b/quickstart.mdx index fc51348..d40f6fa 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,6 +1,7 @@ --- title: "Quickstart" description: "Get an API key, make your first routing request, and draw the route on a map in under three minutes." +icon: "bolt" --- Quickstart takes three steps and three minutes. No credit card required. diff --git a/rate-limits.mdx b/rate-limits.mdx index 25a0ec7..f3b9453 100644 --- a/rate-limits.mdx +++ b/rate-limits.mdx @@ -1,6 +1,7 @@ --- title: "Rate Limits & Quotas" description: "Request quotas, rate limits, and matrix/VRP size limits per plan, plus how `HTTP code=429` responses behave." +icon: "gauge" --- ## Plans at a glance From 609b5ba4a1375fe179b022695269e5b34705b3e5 Mon Sep 17 00:00:00 2001 From: justrouting Date: Wed, 7 Oct 2026 07:07:46 +0000 Subject: [PATCH 3/3] add style.css --- mcp/overview.mdx | 4 +++- style.css | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 style.css diff --git a/mcp/overview.mdx b/mcp/overview.mdx index 7071eab..7b6dc31 100644 --- a/mcp/overview.mdx +++ b/mcp/overview.mdx @@ -1,9 +1,11 @@ --- -title: "MCP" +title: "Overview" description: "Give AI assistants access to JustRouting's routing, geocoding, distance matrix, and vehicle routing capabilities." icon: "sparkles" --- +## JustRouting MCP + JustRouting MCP lets AI assistants such as Claude and Cursor use [JustRouting](https://justrouting.tech/) for road routing, geocoding, distance and travel-time comparison, and multi-vehicle route optimization. Designed for Southeast Asia. diff --git a/style.css b/style.css new file mode 100644 index 0000000..55a5329 --- /dev/null +++ b/style.css @@ -0,0 +1,4 @@ +.sidebar-group-header { + font-size: 1.0rem !important; + color: #2563eb !important; +}