WildAid O-FISH Documentation

The WildAid Marine Program works to protect vulnerable marine environments.

O-FISH (Officer Fishery Information Sharing Hub) is a multi-platform application that enables officers to browse and record boarding report data from their mobile devices.

Developers are expected to follow the MongoDB Community Code of Conduct guidelines.

This repo contains the documentation for end users and developers of all the O-FISH applications and codebases: iOS, Android, Web and Realm. The documentation itself lives at https://wildaid.github.io.

The details behind the data architecture, schema, and partitioning strategy are described in Realm Data and Partitioning Strategy Behind the WildAid O-FISH Mobile Apps.

Prerequisites

This is a Github Pages site that uses Jekyll. You will need to install Jekyll.

Building and testing the documentation

To build the documentation locally, navigate to the publishing source (where this README is) and run: bundle exec jekyll serve

You can see the local site at:
http://localhost:4000

To test that all links work, and all images have alt-tags, and similar issues - run this from the top-level directory (where this README file is):
./script/test_images_links.sh

You must have htmlproofer installed for this to work properly.

Style guide

The style guide includes notes on accessibility, and can be seen in the style directory.