Skip to content

Raklet engineering docs

Welcome — this is the internal engineering knowledge base for rakletv3.

Looking for something?

Hit s or / to focus the search box, or use the left nav — pages are grouped by feature area (Engineering, CI, Testing, Payments, Membership, Coupons, Events, Jobs, Portal, Settings).

Product design — the memory of the product

Every design doc, CEO plan, decision record, and presentation deck behind what we ship is catalogued under Product design. Start there to understand why a feature looks the way it does and what was deliberately cut.

Most-read pages

How this site is built

Static site generator: mkdocs-material. Source: the docs/ folder in this repo. Every push to master triggers a workflow that rebuilds and deploys to GitHub Pages.

Want to edit a page? Click the pencil icon in the top right of any page — it opens the source on GitHub. Pull-request the change like any code edit.

Adding a new doc

  1. Drop a Markdown file under docs/ in the appropriate subfolder (see the left nav for the taxonomy).
  2. Add a line for your new page to the nav: block in mkdocs.yml so it shows up in the sidebar with the title you want — auto-derived titles look ugly (Custommembership Status One-Time Task).
  3. Open a PR. The mkdocs build runs on the PR; deploys on merge to master.

For HTML files (status pages, dashboards), drop them in docs/ exactly like the Markdown ones — they're served raw and linked from index.md.

If you move or rename a page, add a redirect in mkdocs.yml under plugins → redirects → redirect_maps so existing bookmarks keep working.