Skip to content

README: add status badges, navigable TOC, and sync repository tree with current layout#55

Merged
dfeen87 merged 1 commit intomainfrom
copilot/add-badges-and-table-of-contents
Apr 11, 2026
Merged

README: add status badges, navigable TOC, and sync repository tree with current layout#55
dfeen87 merged 1 commit intomainfrom
copilot/add-badges-and-table-of-contents

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

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

    • Added badges for CI workflow status, supported Python version, and license.
  • Navigation

    • Added a linked Table of Contents covering major README sections for one-click jumps.
  • Repository structure accuracy

    • Replaced the stale tree with a current layout reflecting:
      • constraints/ domain folders
      • constraint_core/ and scoring/ C++ components
      • simulations/candidates/
      • current apps/ and tests/ entries
      • key root files including CMakeLists.txt
[![CI](https://github.com/dfeen87/CuraFrame/actions/workflows/ci.yml/badge.svg)](...)
![Python](https://img.shields.io/badge/python-3.9%2B-blue.svg)
[![License](https://img.shields.io/badge/license-Non--Commercial-lightgrey.svg)](LICENSE)

## Table of Contents
- [Abstract](#abstract)
- [Overview](#overview)
- [Repository Structure](#repository-structure)
...

@dfeen87 dfeen87 marked this pull request as ready for review April 11, 2026 09:55
Copilot AI review requested due to automatic review settings April 11, 2026 09:55
@dfeen87 dfeen87 merged commit c8a3370 into main Apr 11, 2026
1 check passed
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@dfeen87 dfeen87 deleted the copilot/add-badges-and-table-of-contents branch April 11, 2026 09:55
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 current apps//tests/ entries.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +128 to +134
├── 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
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +135 to +144
├── apps/ # Application interfaces
│ ├── console_streamlit/ # Streamlit interactive console
│ │ ├── app.py
│ │ └── db_auth.py
│ └── web/ # FastAPI web application
│ ├── main.py
│ ├── api/
│ ├── core/
│ ├── db/
│ └── templates/
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants