feat: v26.6.1 docs#41
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds the generated static documentation site for OSRM API v26.6.1 under docs/v26.6.1/, including the HTML entrypoints, VitePress runtime bundles, and versioned assets used to serve the docs.
Changes:
- Adds VitePress-generated HTML pages for the v26.6.1 docs (home + topic pages).
- Adds the v26.6.1 client-side bundles/assets (JS/CSS chunks, search index, and content modules).
- Adds versioned static assets required by the site (fonts and images) plus a hash map used by VitePress routing.
Reviewed changes
Copilot reviewed 36 out of 67 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/v26.6.1/404.html | Versioned 404 page for the v26.6.1 docs site. |
| docs/v26.6.1/cucumber.html | Generated HTML page for the Cucumber tests documentation. |
| docs/v26.6.1/developing.html | Generated HTML page for development/debugging guidance documentation. |
| docs/v26.6.1/hashmap.json | VitePress content hash map for page/module resolution. |
| docs/v26.6.1/http.html | Generated HTML page for the HTTP API documentation. |
| docs/v26.6.1/index.html | Generated HTML entry for the docs home page. |
| docs/v26.6.1/jsdoc-extract.js | Extracted JSDoc source used for Node.js API documentation content generation. |
| docs/v26.6.1/libosrm.html | Generated HTML page for the libosrm documentation. |
| docs/v26.6.1/nodejs/api.html | Generated HTML page for the Node.js API documentation. |
| docs/v26.6.1/profiles.html | Generated HTML page for profiles documentation. |
| docs/v26.6.1/python/api.html | Generated HTML page for the Python API documentation. |
| docs/v26.6.1/python/development.html | Generated HTML page for Python development documentation. |
| docs/v26.6.1/releasing.html | Generated HTML page describing the release/versioning process. |
| docs/v26.6.1/routed.html | Generated HTML page for osrm-routed configuration documentation. |
| docs/v26.6.1/testing.html | Generated HTML page for testing documentation. |
| docs/v26.6.1/tools.html | Generated HTML page for command-line tools documentation. |
| docs/v26.6.1/vp-icons.css | Versioned VitePress icon CSS used by the docs theme. |
| docs/v26.6.1/windows-deps.html | Generated HTML page for Windows build/dependency documentation. |
| docs/v26.6.1/assets/app.B4WkJDjd.js | VitePress app bootstrap bundle for the v26.6.1 site. |
| docs/v26.6.1/assets/style.CPXwcXL8.css | Versioned CSS bundle for the v26.6.1 docs theme/layout. |
| docs/v26.6.1/assets/chunks/framework.D4c47gkQ.js | VitePress framework runtime chunk. |
| docs/v26.6.1/assets/chunks/theme.DOY_Fw1r.js | VitePress theme runtime chunk. |
| docs/v26.6.1/assets/chunks/VPLocalSearchBox.DO6aiOay.js | Local search UI chunk for the docs site. |
| docs/v26.6.1/assets/chunks/@localSearchIndexroot.4Dd4Fdxv.js | Local search index chunk for the docs site. |
| docs/v26.6.1/assets/cucumber.md.BgffGmGW.js | Compiled content module for cucumber.md. |
| docs/v26.6.1/assets/cucumber.md.BgffGmGW.lean.js | Lean content module variant for cucumber.md. |
| docs/v26.6.1/assets/developing.md.CfW1bbQN.js | Compiled content module for developing.md. |
| docs/v26.6.1/assets/developing.md.CfW1bbQN.lean.js | Lean content module variant for developing.md. |
| docs/v26.6.1/assets/http.md.COq4UgDn.js | Compiled content module for http.md. |
| docs/v26.6.1/assets/http.md.COq4UgDn.lean.js | Lean content module variant for http.md. |
| docs/v26.6.1/assets/index.md.B7ZIkl7G.js | Compiled content module for the home page (index.md). |
| docs/v26.6.1/assets/index.md.B7ZIkl7G.lean.js | Lean content module variant for index.md. |
| docs/v26.6.1/assets/libosrm.md.DenSuQMk.js | Compiled content module for libosrm.md. |
| docs/v26.6.1/assets/libosrm.md.DenSuQMk.lean.js | Lean content module variant for libosrm.md. |
| docs/v26.6.1/assets/nodejs_api.md.DBrFqcOe.js | Compiled content module for nodejs/api.md. |
| docs/v26.6.1/assets/nodejs_api.md.DBrFqcOe.lean.js | Lean content module variant for nodejs/api.md. |
| docs/v26.6.1/assets/profiles.md.GTiPO4Oz.js | Compiled content module for profiles.md. |
| docs/v26.6.1/assets/profiles.md.GTiPO4Oz.lean.js | Lean content module variant for profiles.md. |
| docs/v26.6.1/assets/python_api.md.DlBCfjox.js | Compiled content module for python/api.md. |
| docs/v26.6.1/assets/python_api.md.DlBCfjox.lean.js | Lean content module variant for python/api.md. |
| docs/v26.6.1/assets/python_development.md.Cbe9uYbU.js | Compiled content module for python/development.md. |
| docs/v26.6.1/assets/python_development.md.Cbe9uYbU.lean.js | Lean content module variant for python/development.md. |
| docs/v26.6.1/assets/releasing.md.XAqE_Nb5.js | Compiled content module for releasing.md. |
| docs/v26.6.1/assets/releasing.md.XAqE_Nb5.lean.js | Lean content module variant for releasing.md. |
| docs/v26.6.1/assets/routed.md.BBY2HH7-.js | Compiled content module for routed.md. |
| docs/v26.6.1/assets/routed.md.BBY2HH7-.lean.js | Lean content module variant for routed.md. |
| docs/v26.6.1/assets/testing.md.4Xp8rUfy.js | Compiled content module for testing.md. |
| docs/v26.6.1/assets/testing.md.4Xp8rUfy.lean.js | Lean content module variant for testing.md. |
| docs/v26.6.1/assets/tools.md.Bwog4E_F.js | Compiled content module for tools.md. |
| docs/v26.6.1/assets/tools.md.Bwog4E_F.lean.js | Lean content module variant for tools.md. |
| docs/v26.6.1/assets/windows-deps.md.CzNt0g42.js | Compiled content module for windows-deps.md. |
| docs/v26.6.1/assets/windows-deps.md.CzNt0g42.lean.js | Lean content module variant for windows-deps.md. |
| docs/v26.6.1/assets/example-tile-response.Edf9KoW6.png | Image asset referenced from the HTTP API docs content. |
| docs/v26.6.1/assets/inter-italic-cyrillic-ext.r48I6akx.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-cyrillic.By2_1cv3.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-greek-ext.1u6EdAuj.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-greek.DJ8dCoTZ.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-latin-ext.CN1xVJS-.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-latin.C2AdPX0b.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-italic-vietnamese.BSbpV94h.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-cyrillic-ext.BBPuwvHQ.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-cyrillic.C5lxZ8CY.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-greek-ext.CqjqNYQ-.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-greek.BBVDIX6e.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-latin-ext.4ZJIpNVo.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-latin.Di8DUHzh.woff2 | Versioned Inter font asset used by the theme. |
| docs/v26.6.1/assets/inter-roman-vietnamese.BjW4sHH5.woff2 | Versioned Inter font asset used by the theme. |
Files not reviewed (11)
- docs/v26.6.1/assets/app.B4WkJDjd.js: Language not supported
- docs/v26.6.1/assets/chunks/VPLocalSearchBox.DO6aiOay.js: Language not supported
- docs/v26.6.1/assets/chunks/theme.DOY_Fw1r.js: Language not supported
- docs/v26.6.1/assets/cucumber.md.BgffGmGW.js: Language not supported
- docs/v26.6.1/assets/cucumber.md.BgffGmGW.lean.js: Language not supported
- docs/v26.6.1/assets/developing.md.CfW1bbQN.js: Language not supported
- docs/v26.6.1/assets/developing.md.CfW1bbQN.lean.js: Language not supported
- docs/v26.6.1/assets/http.md.COq4UgDn.lean.js: Language not supported
- docs/v26.6.1/assets/index.md.B7ZIkl7G.js: Language not supported
- docs/v26.6.1/assets/index.md.B7ZIkl7G.lean.js: Language not supported
- docs/v26.6.1/assets/libosrm.md.DenSuQMk.js: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+56
to
+58
| * @param {Boolean} [options.alternatives=false] Search for alternative routes. | ||
| * @param {Number} [options.alternatives=0] Search for up to this many alternative routes. | ||
| * *Please note that even if alternative routes are requested, a result cannot be guaranteed.* |
Comment on lines
+75
to
+77
| * var osrm = new OSRM("berlin-latest.osrm"); | ||
| * osrm.route({coordinates: [[52.519930,13.438640], [52.513191,13.415852]]}, function(err, result) { | ||
| * if(err) throw err; |
| * @param {String} [options.fallback_coordinate] Either `input` (default) or `snapped`. If using a `fallback_speed`, use either the user-supplied coordinate (`input`), or the snapped coordinate (`snapped`) for calculating the as-the-crow-flies distance between two points. | ||
| * @param {Number} [options.scale_factor] Multiply the table duration values in the table by this number for more controlled input into a route optimization solver. | ||
| * @param {String} [options.snapping] Which edges can be snapped to, either `default`, or `any`. `default` only snaps to edges marked by the profile as `is_startpoint`, `any` will allow snapping to any edge in the routing graph. | ||
| * @param {Array} [options.annotations] Return the requested table or tables in response. Can be `['duration']` (return the duration matrix, default), `[distance']` (return the distance matrix), or `['duration', distance']` (return both the duration matrix and the distance matrix). |
Comment on lines
+104
to
+106
| * @returns {Object} containing `waypoints`. | ||
| * **`waypoints`**: array of [`Ẁaypoint`](#waypoint) objects sorted by distance to the input coordinate. | ||
| * Each object has an additional `distance` property, which is the distance in meters to the supplied input coordinate. |
Comment on lines
+149
to
+150
| * **`sources`**: array of [`Ẁaypoint`](#waypoint) objects describing all sources in order. | ||
| * **`destinations`**: array of [`Ẁaypoint`](#waypoint) objects describing all destinations in order. |
Comment on lines
+223
to
+225
| * @returns {Object} containing `tracepoints` and `matchings`. | ||
| * **`tracepoints`** Array of [`Ẁaypoint`](#waypoint) objects representing all points of the trace in order. | ||
| * If the trace point was omitted by map matching because it is an outlier, the entry will be null. |
| @@ -0,0 +1,4 @@ | |||
| import{_ as i,o as s,c as a,ag as n}from"./chunks/framework.D4c47gkQ.js";const u=JSON.parse('{"title":"Building OSRM for Windows","description":"","frontmatter":{},"headers":[],"relativePath":"windows-deps.md","filePath":"windows-deps.md"}'),t={name:"windows-deps.md"};function o(r,e,d,l,p,h){return s(),a("div",null,[...e[0]||(e[0]=[n(`<h1 id="building-osrm-for-windows" tabindex="-1">Building OSRM for Windows <a class="header-anchor" href="#building-osrm-for-windows" aria-label="Permalink to "Building OSRM for Windows""></a></h1><p>There is experimental support for building OSRM on Windows.</p><h2 id="dependencies" tabindex="-1">Dependencies <a class="header-anchor" href="#dependencies" aria-label="Permalink to "Dependencies""></a></h2><p>You will need a modern Windows development stack (e.g. Visual Studio 17). The published binaries are built with <a href="https://github.com/actions/runner-images/blob/main/images/win/Windows2025-Readme.md" target="_blank" rel="noreferrer">Windows Server 2025</a> Github hosted runners.</p><p>Dependencies are managed via <a href="https://vcpkg.io/" target="_blank" rel="noreferrer">vcpkg</a> in manifest mode (see <code>vcpkg.json</code> at the repo root). The baseline commit is pinned in <code>vcpkg-configuration.json</code>.</p><h2 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to "Prerequisites""></a></h2><ol><li>Install Visual Studio 2022 with the "Desktop development with C++" workload.</li><li>Clone vcpkg and bootstrap it:</li></ol><div class="language-bat vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bat</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">git clone https://github.com/microsoft/vcpkg.git C:\\vcpkg</span></span> | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.