update gitignore and add project docs

This commit is contained in:
2026-05-03 05:27:53 -04:00
parent a303d3eb20
commit 39b9d046f0
5 changed files with 167 additions and 0 deletions
+1
View File
@@ -4,6 +4,7 @@ __pycache__/
.pytest_cache/
.venv/
venv/
*.egg-info/
# Environment and secrets
.env
+36
View File
@@ -0,0 +1,36 @@
# ai-exchange Codex Prompts
## Kickoff In This Repo
```text
Read README.md, TASKS.md, SESSION.md, RUNBOOK.md, then inspect git status and the relevant code.
Give me a short execution plan and then implement the highest-priority task.
Run the listed validation commands after changes.
Update SESSION.md and TASKS.md before you stop.
```
## Continue After Login
```text
Continue ai-exchange.
First read README.md, TASKS.md, SESSION.md, RUNBOOK.md and inspect git status and the current branch.
Then continue from the Exact Next Step in SESSION.md.
Implement the change, run validation, and update SESSION.md and TASKS.md before stopping.
```
## Request A Review
```text
Review the current changes in ai-exchange.
Prioritize bugs, regressions, missing tests, unsafe assumptions, and deployment risk.
Keep the summary brief and list findings first with file references.
```
## Close The Session
```text
Before stopping, finish the current atomic change if possible.
Run validation commands.
Update SESSION.md with Completed In Last Session, Exact Next Step, and Risks Or Open Questions.
Move finished items in TASKS.md.
```
+66
View File
@@ -0,0 +1,66 @@
# ai-exchange Runbook
## Project Summary
- Package name: `ai-ict`
- Python version: `>=3.11`
- Main local API port: `8000`
- Default branch observed during setup: `main`
## Setup
```bash
cd /home/yuqei/project/ai-exchange
test -d .venv || uv sync
test -f .env || cp .env.example .env
```
## Local Run
```bash
cd /home/yuqei/project/ai-exchange
.venv/bin/python scripts/run_api_server.py
```
Alternative entrypoints already documented by the project:
```bash
python3 scripts/run_dev.py
python3 scripts/run_pipeline.py
```
## Test And Validation
```bash
cd /home/yuqei/project/ai-exchange
.venv/bin/python -m unittest discover -s tests/unit -p "test_*.py"
.venv/bin/python scripts/run_offline_checks.py
.venv/bin/python scripts/check_local_demo_readiness.py
python3 scripts/run_migration_static_checks.py
python3 scripts/run_script_static_checks.py
```
## Docker
Repo-local compose:
```bash
cd /home/yuqei/project/ai-exchange
docker compose up -d --build
docker compose ps
```
Documented single-set local deployment policy from the repo README:
```bash
cd /root/deploy/ai-ict
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml down --remove-orphans
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml up -d --build
docker compose -p ai-ict -f /root/deploy/ai-ict/docker-compose.yml ps
```
## Notes
- Existing services in `docker-compose.yml`: `ai-ict`
- Existing mapped port in `docker-compose.yml`: `8000:8000`
- Use `SESSION.md` for the exact next step instead of relying on conversation memory.
+42
View File
@@ -0,0 +1,42 @@
# ai-exchange Session
## Current Goal
Stabilize the working state of the repository and make the next development step explicit before continuing feature work.
## Current Branch
`main`
## Last Updated
2026-05-02 America/New_York
## Completed In Last Session
- Added project-local Codex workflow files for multi-project continuation.
- Recorded the current repository state and standard continuation flow.
## Current Working State
- `git status --short` showed: modified `.gitignore`
- `git status --short` showed: untracked `.hermes/`
- `git status --short` showed: untracked `geckodriver.log`
- `git status --short` showed: untracked `uv.lock`
## Exact Next Step
Review the dirty worktree, decide what belongs in version control, then update `TASKS.md` with the single next implementation task.
## Validation Commands
```bash
.venv/bin/python -m unittest discover -s tests/unit -p "test_*.py"
.venv/bin/python scripts/run_offline_checks.py
.venv/bin/python scripts/check_local_demo_readiness.py
```
## Risks Or Open Questions
- The current product priority is not yet recorded in this repo-local workflow.
- The dirty worktree may contain intentional local artifacts, but that is not documented yet.
+22
View File
@@ -0,0 +1,22 @@
# ai-exchange Tasks
## In Progress
- [ ] Reconcile the current dirty worktree and confirm the next product task before new feature work starts.
## Next Up
- [ ] Decide whether `.gitignore`, `.hermes/`, `geckodriver.log`, and `uv.lock` should stay, be ignored, or be committed.
- [ ] After repo state is clarified, promote one concrete feature or bugfix into `In Progress`.
## Backlog
- [ ] Keep this list aligned with the real product backlog instead of mixing notes into chat history.
## Blocked
- [ ] Waiting for product priority clarification if no single next feature is agreed.
## Done
- [x] 2026-05-02 Added Codex multi-project workflow files for independent continuation.