Skip to content

README.md

Latest commit

 

History

History
64 lines (45 loc) · 2.21 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.21 KB

Documentation for the Open Radar Code Architecture (ORCA)

This repository contains the source code for ORCA documentation website found here: https://hisnr.com/orca/

The main ORCA project Github can be found here: https://github.com/HI-SNR-Lab/uhd_radar

Editing this documentation

The documentation uses the Docsy theme module for Hugo. Changes pushed to the main branch are automatically built and will appear on the documentation website.

Any of the ways of running a local version of a Hugo server will work. See the Docsy user guide for details. The easiest option is to use Docker to avoid having to install any dependencies.

Running a container locally

You can run a local copy of the website inside a Docker container, This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.

  1. Build the docker image

    docker compose build

  2. Run the built image

    docker compose up

    NOTE: You can run both commands at once with docker compose up --build.

  3. Verify that the service is working.

    Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the docsy-example homepage. You can now make changes to the docsy example and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C.

To remove the produced images run:

docker compose rm

For more information see the Docker Compose documentation.