Skip to content

Field-Day-2022/field-day-2022.github.io

Repository files navigation

Field Day: Landing Page and Documentation

Welcome to the Field Day Project! This repository serves as the main landing page for Field Day, a comprehensive suite of tools designed to support wildlife researchers in collecting and managing data efficiently. The project is currently under development by a team of students at Arizona State University.

Live Preview Setup

This repository now supports live previewing using Gulp. Follow these steps to set it up:

Prerequisites

  1. Ensure Node.js and npm are installed:

    node --version
    npm --version
  1. Install Gulp globally:

    npm install --global gulp-cli

Running the Live Preview

  1. Install the project dependencies:

    npm install
  2. Run the live preview:

    npm start
Note
  • The server automatically reloads when changes are made to .adoc files or the playbook.

  • To build the site without running the server, use npm run build.

Planned Documentation

This repository will soon include:

  • User Guides: Step-by-step instructions to help researchers and users make the most of the Field Day tools.

  • Contribution Guides: Information for developers interested in contributing to the project.

  • Developer Guides: Technical documentation and guidelines for extending and maintaining the project.

User Interface

The user interface for the Field Day Docs is custom-built and is also part of the Field Day project. Check out the Field Day UI repository for more information.

About

The landing page for the Field Day project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published