diff --git a/docs/components.md b/docs/components.md index f4b584e..e87af9d 100644 --- a/docs/components.md +++ b/docs/components.md @@ -24,4 +24,4 @@ It is written in Go for fast performance. ## Diagram Parser -dg-parser reads diagrams and extracts headcodes and PIS codes before referencing the timetable to find which service the PIS code is valid for. These PIS codes are then semi-automatically added to OwlBoard. \ No newline at end of file +dgp2 reads diagrams and extracts headcodes and PIS codes before referencing the timetable to find which service the PIS code is valid for. These PIS codes are then validated automatically before being manually checked before being added to the database ready to be searched for. \ No newline at end of file diff --git a/docs/contact.md b/docs/contact.md new file mode 100644 index 0000000..064f23d --- /dev/null +++ b/docs/contact.md @@ -0,0 +1,25 @@ +# Still need help? + +If you're still struggling to use OwlBoard you can get in touch. + +email: [api@owlboard.info](mailto:api@owlboard.info) + +## Found something wrong? + +If you have found something wrong with OwlBoards data here's what to do: + +### Incorrect PIS Code: + +You can report an incorrect PIS Code by emailing [api@owlboard.info](mailto:api@owlboard.info) or by submitting a report [here](https://owlboard.info/more/report/). + +### Incorrect Departure Boards: + +If you see an error on a departure board it is likely that the error is not caused by OwlBoard. We fetch live data from National Rail when you request it, short notice changes may not be visible for up to two minutes. + +### Incorrect Timetable Data: + +Our timetable data is provided by Network Rail. Some short notice changes are not published in the timetable - for example diverting trains or additional stops. Timetable data is updated daily with supplemental updates as they become available. + +### Something else? + +Get in touch by emailing [api@owlboard.info](mailto:api@owlboard.info) \ No newline at end of file diff --git a/docs/img/home.png b/docs/img/home.png index c64a532..8f84a9f 100644 Binary files a/docs/img/home.png and b/docs/img/home.png differ diff --git a/docs/img/pis-finder-search.png b/docs/img/pis-finder-search.png index aa037f5..9ab177a 100644 Binary files a/docs/img/pis-finder-search.png and b/docs/img/pis-finder-search.png differ diff --git a/docs/img/pis-finder.png b/docs/img/pis-finder.png deleted file mode 100644 index 5fcd3d7..0000000 Binary files a/docs/img/pis-finder.png and /dev/null differ diff --git a/docs/img/settings.png b/docs/img/settings.png index 5bf39ee..fc37dff 100644 Binary files a/docs/img/settings.png and b/docs/img/settings.png differ diff --git a/docs/menu.md b/docs/menu.md index 39f0f82..d4a1f16 100644 --- a/docs/menu.md +++ b/docs/menu.md @@ -24,7 +24,7 @@ See the [settings guide](settings.md) for details. ## Help -Provides pathways to get help, such as out Facebook group, issue reporting and this help site. +Simply links to this microsite ## About diff --git a/docs/pis.md b/docs/pis.md index 6e5be61..6959172 100644 --- a/docs/pis.md +++ b/docs/pis.md @@ -12,11 +12,11 @@ To find out how to use the timetable search, see the [timetable guide](timetable ## PIS Finder -As an alternative to the Timetable Search, you can use the PIS Finder. Here, you simply enter the CRS code of the start and end station to see matches. +As an alternative to the Timetable Search, you can use the PIS Finder. Here, you simply enter the CRS code of the start and end station to see matches. You can also search for a PIS code by number to see which stops it contains. ![PIS Finder Search](img/pis-finder-search.png) -All PIS codes that match the start and end locations are returned: +All PIS codes that match the start and end locations are returned (Duplicate stopping patterns do exist): ![PIS Finder Results](img/pis-finder-result.png) diff --git a/docs/registering.md b/docs/registering.md index 2a99799..324178c 100644 --- a/docs/registering.md +++ b/docs/registering.md @@ -21,8 +21,9 @@ Registering gives you access to the following features: - Find trains by headcode - Detailed timetable information - PIS code information per-train + - Search for past and future dates -Without registering, you still have access to departure boards but with much less detail and with ECS movements and non-public platform numbers hidden. +Without registering, you still have access to departure boards but from National Rails public feed with much less detail. It will not display non-announced platform numbers or ECS movemebts. ## Registration Detail diff --git a/mkdocs.yml b/mkdocs.yml index 41fa414..7ac0c24 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,8 @@ site_url: https://docs.owlboard.info nav: - 'Go to OwlBoard': https://owlboard.info + - 'Get in Touch': + - 'contact.md' - 'Website': - 'index.md' - 'registering.md'