dist/theme/about-help.html

   1 <h2 class="my-4">About & Help</h2>
   2
   3 <p>
   4   Nominatim is a search engine for <a href="https://www.openstreetmap.org/">OpenStreetMap</a> data.
   5   You may search for a name or address (forward search) or look up data by its geographic coordinate
   6   (reverse search). Each result comes with a link to a details page where you can inspect what data
   7   about the object is saved in the database and investigate how the address of the object has been
   8   computed.
   9 </p>
  10
  11 <p>
  12   This website is the debugging interface for the
  13   <a href="https://nominatim.openstreetmap.org">Nominatim search service</a>
  14   used by the <a href="https://openstreetmap.org">OpenStreetMap website</a>.
  15 </p>
  16
  17 <h3>Documentation</h3>
  18
  19 <p>
  20   API documentation can be found at the
  21   <a href="https://nominatim.org/release-docs/develop/api/Overview/">Nominatim website</a>.
  22   This instance usually runs the latest version of the software and uses
  23   up-to-date data from OpenStreetMap.
  24 </p>
  25
  26 <p>
  27   Please read the <a href="https://operations.osmfoundation.org/policies/nominatim/">Usage Policy</a>
  28   before using the API for your own website or software.
  29 </p>
  30
  31 <h3>Report a problem</h3>
  32
  33 <p>
  34   There is a
  35   <a target="_blank" href="https://nominatim.org/release-docs/develop/api/Faq/">FAQ</a>
  36   for commonly asked questions. For general questions about OpenStreetMap data,
  37   please use <a href="https://help.openstreetmap.org">OSM Help</a>.
  38 </p>
  39 <p>
  40   Use <a target="_blank" href="https://github.com/osm-search/Nominatim/issues">Nominatim issues on github</a>
  41   to report problems.
  42 </p>
  43 <p>
  44   Please ensure that you include a full description of the problem, including the search
  45   query that you used, the problem with the result and, if the problem relates to missing data,
  46   the osm type (node, way, relation) and id of the item that is missing.
  47 </p>
  48 <p>
  49   Problems that contain enough detail are likely to get looked at before ones that require
  50   significant research.
  51 </p>
  52
  53 <h3>Source code</h3>
  54
  55 <p>
  56   This website is based on <a href="https://github.com/osm-search/nominatim-ui">Nominatim UI</a>,
  57   a debugging interface for the <a href="https://nominatim.org/">Nominatim</a> geocoding software.
  58 </p>
  59
  60 <h3>Privacy policy</h3>
  61
  62 <p>
  63   This site and the API are subject to the
  64   <a href="https://wiki.osmfoundation.org/wiki/Privacy_Policy">OSMF privacy policy</a>.
  65 </p>