docs: reconcile documentation to current code state#50
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 35bceceea3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Quick Start map to real files/scripts. | ||
|
|
||
| `backend/run.py` confirmed present. `frontend/package.json` defines `"dev"`, `"build"`, `"preview"` | ||
| scripts. `backend/scripts/seed_demo_data.py` confirmed present (via `backend/app/seed.py` import path |
There was a problem hiding this comment.
This reconciliation marks the run instructions as consistent because backend/scripts/seed_demo_data.py was supposedly found, but the repo only has scripts/seed_demo_data.py and no backend/scripts package; running the documented cd backend && python -m scripts.seed_demo_data exits with ModuleNotFoundError: No module named 'scripts'. Because this sign-off says the quick-start commands map to real files, it leaves users with a demo-seeding command that cannot work from the stated directory.
Useful? React with 👍 / 👎.
| | Auth | Bearer token on admin endpoints; VPN-only for reads | Bearer token required for write endpoints — VPN alone is insufficient | | ||
| | Hosting | Mac Mini + Caddy | Always-on, VPN-accessible; Caddy adds HTTPS + header auth | | ||
| | Dep graph layout | Hierarchical (Dagre), not force-directed | Force-directed is default-off; Dagre is the production default | | ||
| | Dep graph layout | Force-directed (react-force-graph-2d) | Dagre hierarchical layout is deferred; force-directed is current default | |
There was a problem hiding this comment.
Changing the architecture decision to force-directed makes this file contradict itself: the later project instructions still say, “Do not use force-directed layout as default for the dependency graph. Use hierarchical (Dagre).” In contexts where contributors rely on CLAUDE.md, they now get mutually exclusive guidance about the production graph layout, so the lower rule should be updated or removed in the same reconciliation.
Useful? React with 👍 / 👎.
1 participant
Documentation reconciled to current code state by the
/doc-truth-uppass (docs-only: README/CLAUDE/AGENTS/DOC-RECONCILIATION + docs/**). Surgically cherry-picked so only the reconciliation lands.