Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ jobs:
- name: Install documentation dependencies
run: python -m pip install -e '.[docs,env]'
- name: Verify documentation and internal links
run: mkdocs build --strict --site-dir /tmp/labtrust-mkdocs-ci
run: |
mkdocs build --strict --site-dir /tmp/labtrust-mkdocs-ci
test -s /tmp/labtrust-mkdocs-ci/index.html
test -s /tmp/labtrust-mkdocs-ci/getting-started/index.html
- name: Checkout pinned PCS dependency for release viewer
uses: actions/checkout@v4
with:
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ jobs:
run: pip install -e '.[docs,env]'

- name: Build MkDocs
run: mkdocs build --strict
run: |
mkdocs build --strict
test -s site/index.html
test -s site/getting-started/index.html

- name: Checkout pinned PCS dependency for release viewer
uses: actions/checkout@v4
Expand Down
15 changes: 15 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# LabTrust-Gym

LabTrust-Gym is a multi-agent environment for hospital laboratory automation, with benchmarks for coordination, operational policy, risk, and security.

## Start here

- [Getting started](getting-started/index.md) — installation, first experiments, and demonstrations.
- [Architecture](architecture/index.md) — environment design and execution model.
- [Benchmarks and studies](benchmarks/index.md) — evaluation procedures, results, and reproduction.
- [Coordination](coordination/index.md) — multi-agent coordination methods and experiments.
- [Risk and security](risk-and-security/index.md) — risk models, security tests, and controls.
- [Proof-Carrying Science](pcs/index.md) — scientific evidence and release workflows.
- [Operations](operations/index.md) — CI, releases, and operational guidance.

For source code and issue tracking, see the [LabTrust-Gym repository](https://github.com/fraware/LabTrust-Gym).
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ theme:
highlightjs: true

nav:
- Overview: getting-started/index.md
- Overview: index.md
- Getting started:
- getting-started/index.md
- Installation: getting-started/installation.md
Expand Down
Loading