projects · hutfx · ✎ edit

HUTFX Project — Documentation

Status: Live — wiki home, adopted 2026-11-01. This is the single home for all HUTFX project documentation. Markdown here is the source of truth; the same content is served at http://doc.hutfx.com/.

What lives where

Directory What is inside What it is for
web/ Plans and specs for creating the website and its services Product vision, website spec, feature/service plans (e.g. pipeline engine). Anything about what we build and how it should look/behave.
technical/ Servers, network, resources, domains — system administration of hutfx.com Hosts (hut, jaba, petyapc, mail VM), DNS, dev environments, mail, deployment infrastructure. Anything about the systems that run hutfx.com.
development/ How to develop for hutfx.com The branch/PR workflow, technologies used, code snippets, rules of the house — explanations for developers joining the project.
projects/ One file per project/research What each project is, its results and metadata. A "Research" entry = the project itself; a "case study" = model + results + metadata.
security/ Threat models and security reviews Security analysis and hardening notes for the platform.
meetings/ One dated file per working day Raw log of each working session: what was asked, what was done, decisions, open items.
CHANGELOG.md Log of documentation changes Every doc added/changed/removed, with date and author.

Rules of the wiki

  1. One topic = one file. Files are named YYYY-MM-DD-topic.md (dated docs) or plain topic names (living docs like the workflow).
  2. Every directory has an index.md that lists its contents and says what belongs there. New file → add a line to that directory's index + the CHANGELOG.
  3. Docs live only here — never inside the website repo (lab-engine/doc/ copies are legacy).
  4. Living docs (workflow, indexes) are edited in place; dated docs (plans, threat models) are snapshots — supersede them with a new dated file instead of rewriting history.
  5. Status header on every doc: Drafting → Locked → Superseded by <file>.
  6. NEO documents proactively: after any HUTFX working session, useful output (plans, specs, setup records) goes straight into the right category here, and the day's meetings/YYYY-MM-DD.md is written/updated — no need to be asked.
source: DOCS/hutfx/index.md · edit this page · rebuilt by build-wiki