Adding wiki (#41)

Author: aryeko

.gitignore

@@ -11,17 +11,10 @@ htmlcov/
 
 # Data directories
 data/*
-!data/.gitkeep
-!data/raw/
-!data/curated/
-data/raw/*
-!data/raw/.gitkeep
-data/curated/*
-!data/curated/.gitkeep
+!data/sample-holdings.json
 
 # Reports directory
-reports/*
-!reports/.gitkeep
+reports/
 
 # VSCode
 .vscode/

README.md

@@ -25,24 +25,26 @@ git clone https://github.com/aryeko/trading-system
 cd trading-system
 poetry install
 
-poetry run ts run daily --config data/sample.yaml
+poetry run ts run daily --config configs/sample-config.yml --holdings data/sample-holdings.json --dry-run
 ```
 
+Sample onboarding assets live under `configs/` (configuration) and `data/` (sample holdings). Update the universe, holdings snapshot, and notification settings before running against live capital.
+
 ## Usage Examples
 
 ```bash
 # Evaluate portfolio risk with point-in-time context
-poetry run ts risk evaluate --config data/sample.yaml --holdings data/holdings.json
+poetry run ts risk evaluate --config configs/sample-config.yml --holdings data/sample-holdings.json
 
 # Execute the full daily pipeline with rebalance proposals
-poetry run ts run rebalance --config data/sample.yaml --holdings data/holdings.json
+poetry run ts run rebalance --config configs/sample-config.yml --holdings data/sample-holdings.json --dry-run
 
 # Run a historical backtest across a custom period
-poetry run ts backtest run --config data/sample.yaml --start 2024-01-01 --end 2024-06-30 --output reports/backtests/demo
+poetry run ts backtest run --config configs/sample-config.yml --start 2024-01-01 --end 2024-06-30 --output reports/backtests/demo
 ```
 
 ## Documentation
-Comprehensive setup guides, operational workflows, and configuration references live in the [Wiki](https://github.com/aryeko/trading-system/wiki).
+Comprehensive setup guides, operational workflows, and configuration references live in the [Wiki](https://github.com/aryeko/trading-system/wiki). For the original workflow contract and design requirements, see [`docs/WORKFLOW.md`](docs/WORKFLOW.md) and [`docs/TECH_DESIGN_REQUIREMENTS.md`](docs/TECH_DESIGN_REQUIREMENTS.md).
 
 ## Roadmap
 - ✅ Daily capital protection checks

configs/.gitkeep

@@ -0,0 +1,8 @@
+{
+  "as_of_date": "2024-09-23",
+  "base_ccy": "USD",
+  "cash": 10000,
+  "positions": [
+    { "symbol": "SPY", "qty": 50, "cost_basis": 420.0 }
+  ]
+}