Imported from londonaicentre/FLIP (
docs/AGENTS.md). Install upstream withnpx skills add londonaicentre/FLIP --skill docs. Copyright stays with the author.
AGENTS.md — FLIP Documentation
Documentation Index (read on demand)
| File | Topic |
|---|---|
source/overview.rst |
Project overview, architecture, motivation |
source/components.rst |
Toctree of the component pages (Overview, Central Hub, FL nets, Trust APIs, OMOP, XNAT, PACS, Logging Stack) |
source/sys-admin.rst |
System administration, deployment, auth configuration |
source/user-guides.rst |
User-facing workflows and guides |
source/api-reference.rst |
Auto-generated Python module reference (sphinx-autoapi); the REST endpoint table lives in source/components/component-central-hub.rst |
source/deploy-flip.rst |
Deployment instructions (central hub, TRE, on-prem) |
source/working-with-flip-apps.rst |
Building FL apps (NVFLARE / Flower) |
source/flip-workflow.rst |
End-to-end FLIP workflow |
source/faqs.rst |
Frequently asked questions |
source/glossary.rst |
Terminology definitions |
source/security.rst |
How FLIP addresses security at each layer (network, cloud estate, identity, clinical-data boundary, the FL process itself, storage/transport, supply chain) — written for partner trusts and information governance leads |
source/governance-and-compliance.rst |
Who decides what in FLIP and how the platform maps onto NHS assurance frameworks — written for information governance/Caldicott functions and research ethics committees; companion to security.rst |
Sub-docs
| Directory | Topic |
|---|---|
source/components/ |
Per-component deep dives: overview (component map), component-central-hub (hub services + the generated AWS diagram), component-fl-nets (nets, scheduler, job types, config, privacy filters), component-trust-apis (trust-api / imaging-api / data-access-api), OMOP, XNAT, PACS, logging stack |
source/sys-admin/ |
Admin tasks (user roles, project/user management, platform support) |
source/user-guides/ |
User guide files |
source/deploy-flip/ |
Per-target deployment guides (central hub, TRE, on-prem) |
source/working-with-flip-apps/ |
Step-by-step FLARE / Flower app authoring |
Paired pages
source/working-with-flip-apps/create-flip-app-from-flare.rst and create-flip-app-from-flower.rst are twins: same section order, same SDK touchpoints, each ending in a Common pitfalls list, and each carrying a note at the top pointing at the other. When one page changes — a new SDK call, a renamed run-config key, a new pitfall, a restructured section — check whether the other needs the same change, and make both edits in the same PR. The backend-specific facts differ (the comparison table at the top of the FLARE page summarises them), but the shape of the two pages should not drift apart.
How to Read
When implementing a feature that touches documentation, read the relevant .rst file(s) above. These are ReStructuredText format used by Sphinx for ReadTheDocs builds.
Build Commands
cd docs && make clean # Clean built docs (also drops source/assets/generated/)
cd docs && make docs # Build Sphinx HTML documentationThe build needs graphviz (dot) on PATH: conf.py's builder-inited hook renders the Central Hub AWS
diagrams from deploy/providers/AWS/architecture/central_hub.py into the gitignored
source/assets/generated/ and fails loudly without it (ReadTheDocs installs it via build.apt_packages,
the docs CI job via apt-get). FLIP_DOCS_SKIP_DIAGRAMS=1 make docs builds text-only on a host without
graphviz — with a warning, and missing-image warnings on the Central Hub page. Pages renamed in FLIP#364
keep their old URLs through sphinx-reredirects (redirects in conf.py).