Skip to content

Commit 73abcd7

Browse files
authored
Restructure documentation folder (#589)
* Rename docs directory to Documentation. * Rename documentation folder, split into reference and specification. * Update image links * Move the evaluation doc from the wiki
1 parent e25d24d commit 73abcd7

File tree

10 files changed

+353
-6
lines changed

10 files changed

+353
-6
lines changed

Documentation/Reference/comparison.adoc

Lines changed: 348 additions & 0 deletions
Large diffs are not rendered by default.
File renamed without changes.

docs/olc_definition.adoc renamed to Documentation/Specification/olc_definition.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ used for formatting are referred to as "characters".
184184
Open Location Codes are encodings of WGS84 latitude and longitude
185185
coordinates in degrees. Decoding a code returns an area, not a point. The
186186
area of a code depends on the length (longer codes are more precise with
187-
smaller areas). A two-digit code has height and width<<height_width>> of 20
187+
smaller areas). A two-digit code has height and width <<height_width>> of 20
188188
degrees, and with each pair of digits added to the code, both height and
189189
width are divided by 20.
190190

@@ -199,7 +199,7 @@ to be truncated, resulting in a larger area.
199199

200200
[[fig_olc_area]]
201201
.Comparing areas of four and six digit Open Location Codes
202-
image::images/code_areas.png[width=400,height=350,align="center"]
202+
image::../images/code_areas.png[width=400,height=350,align="center"]
203203

204204
The large rectangle in <<fig_olc_area>> is the Open Location Code 8FVC (1
205205
degree height and width). The smaller rectangle is the code 8FVC22 (1/20
@@ -209,7 +209,7 @@ A 10 digit code represents a 1/8000° by 1/8000° area. (At the equator,
209209
this is approximately 13.9 meters x 13.9 meters.)
210210

211211
.10 digit Open Location Code (1/8000 degree resolution), 10.5m x 13.9m
212-
image::images/olc_10_character.png[width=406,height=272,align="center"]
212+
image::../images/olc_10_character.png[width=406,height=272,align="center"]
213213

214214
A 10 digit code will be precise enough for many locations. However, in
215215
areas where building density is high (such as informal settlements,
@@ -229,7 +229,7 @@ Using a single grid refinement step, we have an 11 digit code that
229229
represents a 1/32000° by 1/40000° area (roughly 3.4 by 2.7 meters at the equator).
230230

231231
.A 10 digit code divided into its grid. In this location, each small square is approximately 2.6m x 2.8m
232-
image::images/olc_11_grid.png[width=406,height=272,align="center"]
232+
image::../images/olc_11_grid.png[width=406,height=272,align="center"]
233233

234234
The first approach (where a pair of digits is added for each step)
235235
provides codes that can be visually compared, or alphabetically ordered to
@@ -326,7 +326,7 @@ Refer to link:specification.md[Open Location Code Specification].
326326
[bibliography]
327327
== Notes
328328

329-
- [[[poste_restante]]]Post restante (French: lit. post remaining or general
329+
- [[[poste_restante]]] Post restante (French: lit. post remaining or general
330330
delivery) is a service where a delivery is made to a post office that holds
331331
the package until the recipient calls for it.
332332
- [[[height_width]]] "Height" and "width" are used as a shorthand for north/south
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/comparison.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)