Skip to content

Home

Developer (and company) documentation for WasteSentry.

Updating the docs

We use mkdocs, for documentation visit mkdocs.org.

Commands

  • uv sync --group docs - Install the dependencies for running the docs locally.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Repositories overview

This is an overview of the more important repos in this org, and how they fit together.

trak

Like "Tracking hazardous waste". This repo contains the backed API, as well as the project documentation, the database schema (migrations), and the code here generally reflects the busienss logic that that's important to our business.

watchman

Watchman holds the web application frontend for the project. At the time of writing, it's a react SPA; we're keeping things minimal to try and keep options open (I figure it's easier to migrate from a simple react app to a framework like Next or Tanstack Start than the other way around). "Watchman" is a play on our company name, not tied to it.

site

This holds the static site for the company at https://wastesentry.com. It's an astro 'app' that's statically generated but should allow us to semi-easily write articles. Since it's a static site, it cheap to deploy to something like cloudflare pages or GitHub pages.

ws-infra

The Infrastructure as code (IaC) for the project. Primarily uses terraform/openTofu to provision resources from cloud providers. See this article for an explaination of the why of IaC