mirror of
https://github.com/velocitatem/PHANTOM.git
synced 2026-07-16 01:53:37 +00:00
adding docs
This commit is contained in:
21
docs/src/index.md
Normal file
21
docs/src/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# PHANTOM platform documentation
|
||||
|
||||
Welcome. This site mirrors the **operator and research** documentation for the PHANTOM repository: a research platform for studying **dynamic pricing** under **LLM-mediated browsing and transaction orchestration**, with ties to the academic thesis.
|
||||
|
||||
## Start here
|
||||
|
||||
| Document | Audience |
|
||||
| --- | --- |
|
||||
| [Setup](platform-setup.md) | Full walkthrough: Docker/web/ingest, kernels, contamination, RL training, and audit—content from `SETUP.md` in the repo. |
|
||||
| [Configuration reference](configuration.md) | Env vars, paths, and Makefile entrypoints in one place. |
|
||||
| [Roadmap & implementation notes](roadmap.md) | What is turnkey vs research-grade; thesis vs code. |
|
||||
|
||||
## Canonical sources in the repo
|
||||
|
||||
- Thesis PDF: [thesis-latest.pdf](https://pub-d5b94a3c29fd40c6b3881946e463fdb7.r2.dev/thesis-latest.pdf)
|
||||
- Root onboarding: single file [`SETUP.md`](https://github.com/velocitatem/PHANTOM/blob/main/SETUP.md) (included on this site via snippets—edit that file to change content).
|
||||
- Quick start and command tables: [`README.md`](https://github.com/velocitatem/PHANTOM/blob/main/README.md)
|
||||
|
||||
## Academic project page
|
||||
|
||||
The research landing page (figures, abstract, links) is the site root on GitHub Pages: [velocitatem.github.io/PHANTOM/](https://velocitatem.github.io/PHANTOM/). Open **Documentation** in the Project Links menu there to return to this subsite.
|
||||
Reference in New Issue
Block a user