Skip to content

Commit

Permalink
docs: add index.md to markdown links for IDE navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGreatRefrigerator committed Feb 10, 2024
1 parent 5a77443 commit 63614f1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
22 changes: 11 additions & 11 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@

The fastest way to get to the info you are looking for is **the search bar above**. If that doesn't work, the sidebar has you covered:

* The [API Reference](api-reference/) contains info about openrouteservice's API [endpoints](api-reference/endpoints/) and usage, both for using the [public API](https://openrouteservice.org/dev/#/api-docs) and using locally run instances of openrouteservice.
* [Directions](api-reference/endpoints/directions/) endpoint
* [Isochrones](api-reference/endpoints/isochrones/) endpoint
* [Matrix](api-reference/endpoints/matrix/) endpoint
* [Snapping](api-reference/endpoints/snapping/) endpoint _(not available in our live API)_
* [Export](api-reference/endpoints/export/) endpoint _(not available in our live API)_
* [Run ORS instance](run-instance/) contains all info about setting up the ors locally.
* The [API Reference](api-reference/index.md) contains info about openrouteservice's API [endpoints](api-reference/endpoints/index.md) and usage, both for using the [public API](https://openrouteservice.org/dev/#/api-docs) and using locally run instances of openrouteservice.
* [Directions](api-reference/endpoints/directions/index.md) endpoint
* [Isochrones](api-reference/endpoints/isochrones/index.md) endpoint
* [Matrix](api-reference/endpoints/matrix/index.md) endpoint
* [Snapping](api-reference/endpoints/snapping/index.md) endpoint _(not available in our live API)_
* [Export](api-reference/endpoints/export/index.md) endpoint _(not available in our live API)_
* [Run ORS instance](run-instance/index.md) contains all info about setting up the ors locally.
* [System requirements](run-instance/system-requirements)
* [Data](run-instance/data) used by openrouteservice
* [Installation](run-instance/installation/) either directly using [JAR / WAR](run-instance/installation/running-jar-war) artifacts, with [Docker](run-instance/installation/running-with-docker) or [building from source](run-instance/installation/building-from-source)
* [Configuration](run-instance/configuration/) of openrouteservice instances
* [Contributing](contributing/) contains info about contributing to the openrouteservice, the OpenStreetMap and [translations](contributing/contributing-translations)
* [Technical details](technical-details/) contains all sorts of explanation about the internal workings of the openrouteservice.
* [Installation](run-instance/installation/index.md) either directly using [JAR / WAR](run-instance/installation/running-jar-war) artifacts, with [Docker](run-instance/installation/running-with-docker) or [building from source](run-instance/installation/building-from-source)
* [Configuration](run-instance/configuration/index.md) of openrouteservice instances
* [Contributing](contributing/index.md) contains info about contributing to the openrouteservice, the OpenStreetMap and [translations](contributing/contributing-translations)
* [Technical details](technical-details/index.md) contains all sorts of explanation about the internal workings of the openrouteservice.
* [FAQ](frequently-asked-questions) contains answers to frequently asked questions.

For a more general overview, visit our website at [openrouteservice.org](https://openrouteservice.org).
Expand Down
4 changes: 2 additions & 2 deletions docs/run-instance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ You can then modify the configuration and source file settings to match your nee

## Installation

Please read the documentation regarding [system requirements](system-requirements) and [data](data) before continuing to properly [install](installation/) your openrouteservice instance.
Please read the documentation regarding [system requirements](system-requirements) and [data](data) before continuing to properly [install](installation/index.md) your openrouteservice instance.

For more information on configuring openrouteservice for your specific needs, see the [configuration](configuration/) documentation.
For more information on configuring openrouteservice for your specific needs, see the [configuration](configuration/index.md) documentation.

0 comments on commit 63614f1

Please sign in to comment.