Skip to content

Commit

Permalink
Improve docs (slightly)
Browse files Browse the repository at this point in the history
  • Loading branch information
JimBacon committed Aug 29, 2024
1 parent 7eb5136 commit d48bfb8
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 11 deletions.
14 changes: 5 additions & 9 deletions docs/countries.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# Country Boundaries

At validation we can, if a vice county is provided, check a spatial reference
falls within that vice county. See valid_vc.md
falls within that vice county. See [vice county validation](valid_vc.md).

At verification, we may have to check a record falls within the known
distribution for the species. See rules/without_polygon.md
distribution for the species. See [distribution rule](rules/without_polygon.md).

In both cases the rule data is a list of grid squares while a record may be
In both cases the county data is a list of grid squares while a record may be
supplied with a latitude and longitude.

There are two ways to determine if a point is in a list of grid squares:

* Convert the list of grid squares in to a polygon in a spatially enabled
database (or similar) and perform an intersection with the point.
* Convert the point in to a grid reference and see if it matches an entry in
the list.
To determine if a point is in a list of grid squares we convert the point in to
a grid reference and see if it matches an entry in the list.

To transform a lat/lon in to a grid reference, we need to know which grid
reference system to use - British, Irish or Channel Islands. That can be decided
Expand Down
21 changes: 20 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
Record Cleaner Service
# Record Cleaner Service

The Record Cleaner service exists to validate and verify biological records
against a set of rules.

The API is, to a large extent, self-documenting thanks to
[Swagger UI](https://github.com/swagger-api/swagger-ui). It presents an
interactive interface where you can exercise the API from a browser. This is
located at {base_url}/docs.

The documentation here fills in some additional detail you will need.

* [Date validation](valid_date.md)
* [Spatial reference validation](valid_sref.md)
* [Vice county validation](valid_vc.md)





4 changes: 3 additions & 1 deletion docs/valid_vc.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
#Vice County
#Vice County

[Calculating a grid reference from a Lat/lon](countries.md)

0 comments on commit d48bfb8

Please sign in to comment.