mirror of
https://github.com/velocitatem/PHANTOM.git
synced 2026-05-31 08:33:36 +00:00
adding docs
This commit is contained in:
10
README.md
10
README.md
@@ -142,7 +142,10 @@ flowchart LR
|
||||
| `experiments/` | Data processing, ETL ideas, and analysis assets |
|
||||
| `docker/` | Dockerfiles for platform services |
|
||||
| `tests/e2e/` | Playwright end-to-end tests |
|
||||
| `docs/` | Academic project page source |
|
||||
| `docs/` | Academic project page (GitHub Pages root) + MkDocs config |
|
||||
| `docs/src/` | Markdown sources for the operator documentation site |
|
||||
| `docs/documentation/` | MkDocs build output (gitignored; run `make docs.platform`; served at `/documentation/` on Pages) |
|
||||
| `SETUP.md` | Unified operator guide: stack, kernels, RL training, thesis refs by chapter |
|
||||
|
||||
## Operational notes
|
||||
|
||||
@@ -151,6 +154,11 @@ flowchart LR
|
||||
- Research commands (`make train`, `make benchmark*`, `make train.agent`) auto-load `.env.sweep`.
|
||||
- Paper builds call `paper/concat_code.sh` before compilation to flatten code into the appendix.
|
||||
|
||||
## Operator documentation
|
||||
|
||||
- Full setup guide (platform + research): [`SETUP.md`](SETUP.md)
|
||||
- Hosted operator docs (after `make docs.platform`): […/PHANTOM/documentation/](https://velocitatem.github.io/PHANTOM/documentation/) on GitHub Pages
|
||||
|
||||
## Research artifacts
|
||||
|
||||
- Thesis PDF: `thesis-latest.pdf` or [hosted PDF](https://pub-d5b94a3c29fd40c6b3881946e463fdb7.r2.dev/thesis-latest.pdf)
|
||||
|
||||
Reference in New Issue
Block a user