wip

Author: MarcelloPerathoner

CHANGELOG.md

@@ -1,5 +1,9 @@
+# Changelog
+
 # Unreleased
   - Changes from 6.0.0
+    - Features
+      - ADDED: Pedestrian area routing [#7161](https://github.com/Project-OSRM/osrm-backend/pull/7161)
 
 # 6.0.0
   - Changes from 6.0.0 RC2: None
@@ -182,7 +186,7 @@
       - CHANGED: Docker build, enabled arm64 build layer [#6172](https://github.com/Project-OSRM/osrm-backend/pull/6172)
       - CHANGED: Docker build, enabled apt-get update/install caching in separate layer for build phase [#6175](https://github.com/Project-OSRM/osrm-backend/pull/6175)
       - FIXED: Bump CI complete meta job to ubuntu-20.04 [#6323](https://github.com/Project-OSRM/osrm-backend/pull/6323)
-      - CHANGED: Node packages are now scoped by @project-osrm [#6386](https://github.com/Project-OSRM/osrm-backend/issues/6386)
+      - CHANGED: Node packages are now scoped by \@project-osrm [#6386](https://github.com/Project-OSRM/osrm-backend/issues/6386)
     - Routing:
       - CHANGED: Lazily generate optional route path data [#6045](https://github.com/Project-OSRM/osrm-backend/pull/6045)
       - FIXED: Completed support for no_entry and no_exit turn restrictions. [#5988](https://github.com/Project-OSRM/osrm-backend/pull/5988)
@@ -217,7 +221,7 @@
     - Build:
       - CHANGED: Node binaries now use Github Releases for hosting [#6030](https://github.com/Project-OSRM/osrm-backend/pull/6030)
     - Misc:
-      - FIXED: Upgrade to @mapbox/node-pre-gyp fix various bugs with Node 12/14 [#5991](https://github.com/Project-OSRM/osrm-backend/pull/5991)
+      - FIXED: Upgrade to \@mapbox/node-pre-gyp fix various bugs with Node 12/14 [#5991](https://github.com/Project-OSRM/osrm-backend/pull/5991)
       - FIXED: `valid` type in documentation examples [#5990](https://github.com/Project-OSRM/osrm-backend/issues/5990)
       - FIXED: Remove redundant loading of .osrm.cell_metrics [#6019](https://github.com/Project-OSRM/osrm-backend/issues/6019)
       - CHANGED: Increase PackedOSMIDs size to 34 bits. This breaks the **data format** [#6020](https://github.com/Project-OSRM/osrm-backend/issues/6020)

CONTRIBUTING.md

@@ -1,18 +1,21 @@
-# Everyone
+# Contributing
+
+## Everyone
 
 Please take some time to review our [code of conduct](CODE-OF-CONDUCT.md) to help guide your interactions with others on this project.
 
-# User
+## User
 
 Before you open a new issue, please search for older ones that cover the same issue.
 In general "me too" comments/issues are frowned upon.
 You can add a :+1: emoji reaction to the issue if you want to express interest in this.
 
-# Developer
+## Developer
 
 We use `clang-format` version `15` to consistently format the code base. There is a helper script under `scripts/format.sh`.
 The format is automatically checked by the `mason-linux-release` job of a Travis CI build.
 To save development time a local hook `.git/hooks/pre-push`
+
 ```
 #!/bin/sh
 
@@ -28,16 +31,16 @@ if [ x"$remote" = xorigin  ] ; then
     fi
 fi
 ```
+
 could check code format, modify a local repository and reject push due to unstaged formatting changes.
-Also `pre-push` hook  rejects direct pushes to `origin/master`.
+Also `pre-push` hook rejects direct pushes to `origin/master`.
 
 ⚠️ `scripts/format.sh` checks all local files that match `*.cpp` or `*.hpp` patterns.
 
-
 In general changes that affect the API and/or increase the memory consumption need to be discussed first.
 Often we don't include changes that would increase the memory consumption a lot if they are not generally usable (e.g. elevation data is a good example).
 
-## Pull Request
+### Pull Request
 
 Every pull-request that changes the API needs to update the docs in `docs/http.md` and add an entry to `CHANGELOG.md`.
 Breaking changes need to have a BREAKING prefix. See the [releasing documentation](docs/releasing.md) on how this affects the version.
@@ -57,25 +60,25 @@ If you do have commit access there are in general two accepted styles to merging
 
 1. Make sure the branch is up to date with `master`. Run `git rebase master` to find out.
 2. Once that is ensured you can either:
-  - Click the nice green merge button (for a non-fast-forward merge)
-  - Merge by hand using a fast-forward merge
+
+- Click the nice green merge button (for a non-fast-forward merge)
+- Merge by hand using a fast-forward merge
 
 Which merge you prefer is up to personal preference. In general it is recommended to use fast-forward merges because it creates a history that is sequential and easier to understand.
 
-# Maintainer
+## Maintainer
 
-## Doing a release
+### Doing a release
 
 There is an in-depth guide around how to push out a release once it is ready [here](docs/releasing.md).
 
-## The API
+### The API
 
 Changes to the API need to be discussed and signed off by the team. Breaking changes even more so than additive changes.
 
-## Milestones
+### Milestones
 
 If a pull request or an issue is applicable for the current or next milestone, depends on the target version number.
 Since we use semantic versioning we restrict breaking changes to major releases.
 After a Release Candidate is released we usually don't change the API anymore if it is not critical.
 Bigger code changes after a RC was released should also be avoided.
-

README.md

@@ -1,11 +1,11 @@
-## Open Source Routing Machine
-
+# Open Source Routing Machine
 
 [![osrm-backend CI](https://github.com/Project-OSRM/osrm-backend/actions/workflows/osrm-backend.yml/badge.svg)](https://github.com/Project-OSRM/osrm-backend/actions/workflows/osrm-backend.yml) [![Discord](https://img.shields.io/discord/1034487840219860992)](https://discord.gg/es9CdcCXcb)
 
 High performance routing engine written in C++ designed to run on OpenStreetMap data.
 
 The following services are available via HTTP API, C++ library interface and NodeJs wrapper:
+
 - Nearest - Snaps coordinates to the street network and returns the nearest matches
 - Route - Finds the fastest route between coordinates
 - Table - Computes the duration or distances of the fastest route between all pairs of supplied coordinates
@@ -18,6 +18,7 @@ To quickly try OSRM use our [demo server](http://map.project-osrm.org) which com
 For a quick introduction about how the road network is represented in OpenStreetMap and how to map specific road network features have a look at [the OSM wiki on routing](https://wiki.openstreetmap.org/wiki/Routing) or [this guide about mapping for navigation](https://web.archive.org/web/20221206013651/https://labs.mapbox.com/mapping/mapping-for-navigation/).
 
 Related [Project-OSRM](https://github.com/Project-OSRM) repositories:
+
 - [osrm-frontend](https://github.com/Project-OSRM/osrm-frontend) - User-facing frontend with map. The demo server runs this on top of the backend
 - [osrm-text-instructions](https://github.com/Project-OSRM/osrm-text-instructions) - Text instructions from OSRM route response
 - [osrm-backend-docker](https://github.com/project-osrm/osrm-backend/pkgs/container/osrm-backend) - Ready to use Docker images
@@ -40,6 +41,7 @@ Related [Project-OSRM](https://github.com/Project-OSRM) repositories:
 The easiest and quickest way to setup your own routing engine is to use Docker images we provide.
 
 There are two pre-processing pipelines available:
+
 - Contraction Hierarchies (CH)
 - Multi-Level Dijkstra (MLD)
 
@@ -85,13 +87,13 @@ After adding yourself to the `docker` group make sure to log out and back in aga
 
 We support the following images in the Container Registry:
 
-Name | Description
------|------
-`latest` | `master` compiled with release flag
-`latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols
-`latest-debug` | `master` compiled with debug flag
-`<tag>` | specific tag compiled with release flag
-`<tag>-debug` | specific tag compiled with debug flag
+| Name                | Description                                                                    |
+| ------------------- | ------------------------------------------------------------------------------ |
+| `latest`            | `master` compiled with release flag                                            |
+| `latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols |
+| `latest-debug`      | `master` compiled with debug flag                                              |
+| `<tag>`             | specific tag compiled with release flag                                        |
+| `<tag>-debug`       | specific tag compiled with debug flag                                          |
 
 ### Building from Source
 
@@ -165,7 +167,6 @@ For usage details have a look [these API docs](docs/nodejs/api.md).
 
 An exemplary implementation by a 3rd party with Docker and Node.js can be found [here](https://github.com/door2door-io/osrm-express-server-demo).
 
-
 ## References in publications
 
 When using the code in a (scientific) publication, please cite

docs/areas.md

@@ -1,4 +1,4 @@
-@page pedestrian_areas Pedestrian Areas
+# Pedestrian Areas {#pedestrian_areas}
 
 @sa AreaManager
 
@@ -45,7 +45,7 @@ function setup()
 end
 ```
 
-### process_relation(profile, relation, relations)
+## process_relation(profile, relation, relations)
 
 The @ref process_relation function is called for every relation in the input file. If
 you want a relation to be meshed, you must call [area_manager:relation()](@ref AreaManager::relation()).
@@ -61,7 +61,7 @@ function process_relation(profile, relation, relations)
 end
 ```
 
-### process_way(profile, way, result, relations)
+## process_way(profile, way, result, relations)
 
 The @ref process_way function is called for every way in the input file. If you want a
 closed way to be meshed, call [area_manager:way()](@ref AreaManager::way()). (Note that