Skip to content

README.md

Latest commit

 

History

History
51 lines (37 loc) · 1.98 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.98 KB

UAARG Guidebook

[Read it Now]

This is an mdbook containing documentation and tutorials for those working with the UAARG code bases.

The entire book is meant to be self-contained. It should link to or explain all concepts new members need to be productive on our codebases. Larger concepts like Python programming or CS theory would be out of scope, but resources should still be linked where possible.

The book is viewable at uaarg.com/guide.

Working on the Guide

First, of course, clone this repository locally onto your machine.

You will need mdbook installed. You can follow the mdbook installation guide to get started.

Then, I usually run the mdbook serve command from the root of the repository:

$ mdbook serve
2023-09-02 16:06:31 [INFO] (mdbook::book): Book building has started
2023-09-02 16:06:31 [INFO] (mdbook::book): Running the html backend
2023-09-02 16:06:31 [INFO] (mdbook::cmd::serve): Serving on: http://localhost:3000
2023-09-02 16:06:31 [INFO] (mdbook::cmd::watch): Listening for changes...
2023-09-02 16:06:31 [INFO] (warp::server): Server::run; addr=[::1]:3000
2023-09-02 16:06:31 [INFO] (warp::server): listening on http://[::1]:3000

The book can then be previewed at localhost:3000.

Deploying Updates

Whenever a commit lands on the main branch, Github Actions will deploy it to uaarg.com/guide. This process takes ~30s.

Technical Details

  • We run the .github/workflows/mdbook.yml action on each commit to main
  • This downloads and runs mdbook on the latest commit
  • Then the resulting artifacts are uploaded to github pages
  • Github pages already hosts all of the content on uaarg.com
    • The resulting HTML (generated by mdbook) is appended to this site under /guide