Conversation
Agent-Logs-Url: https://github.com/dfeen87/CuraFrame/sessions/98efedcf-bef9-44df-8563-34579ce98e26 Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
Updates the top-level README.md to improve scanability (badges + TOC) and to refresh the documented repository layout so it reflects the current project structure.
Changes:
- Added status badges (CI, Python version, license) at the top of the README.
- Added a linked Table of Contents for faster navigation.
- Replaced the stale “Repository Structure” tree with an updated layout including
constraints/, C++ components, and currentapps//tests/entries.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ├── cura_frame/ # Core reasoning engine (library) | ||
| │ ├── core.py # Constraint evaluation engine | ||
| │ ├── constraints_library.py # Canonical constraint definitions | ||
| │ ├── bundles.py # Bundle registry helpers | ||
| │ ├── comparators.py # Comparator semantics | ||
| │ ├── db.py # SQLite-backed auth/user helpers | ||
| │ └── cli.py # Command-line interface |
There was a problem hiding this comment.
The repository tree claims cura_frame/ contains only the listed modules, but cura_frame/__init__.py exists in the repo. Since this PR is aiming to keep the tree in sync with the actual layout, either add __init__.py to the tree or explicitly note that the listing is non-exhaustive.
| ├── apps/ # Application interfaces | ||
| │ ├── console_streamlit/ # Streamlit interactive console | ||
| │ │ ├── app.py | ||
| │ │ └── db_auth.py | ||
| │ └── web/ # FastAPI web application | ||
| │ ├── main.py | ||
| │ ├── api/ | ||
| │ ├── core/ | ||
| │ ├── db/ | ||
| │ └── templates/ |
There was a problem hiding this comment.
The apps/ portion of the repository tree omits files that exist (apps/__init__.py, apps/__main__.py, and apps/web/__init__.py, plus apps/console_streamlit/__init__.py). To keep the README structure accurate, include these or clarify that the tree shows only selected entries.
The README lacked quick-status metadata and fast navigation, and its repository tree no longer reflected the actual project structure. This PR updates the top-level documentation for scanability and structural accuracy.
Top-of-file metadata
Navigation
Repository structure accuracy
constraints/domain foldersconstraint_core/andscoring/C++ componentssimulations/candidates/apps/andtests/entriesCMakeLists.txt