Skip to content

[Documentation] Update README to reflect actual project structure#16

Merged
JunchenMeteor merged 2 commits into
JunchenMeteor:mainfrom
ConnorQi01:dev/v-peq/readme_update
Apr 28, 2026
Merged

[Documentation] Update README to reflect actual project structure#16
JunchenMeteor merged 2 commits into
JunchenMeteor:mainfrom
ConnorQi01:dev/v-peq/readme_update

Conversation

@ConnorQi01

Copy link
Copy Markdown
Contributor

Summary

Update README to match the actual codebase. Remove references to files and features that do not exist.

Changes

  • Remove non-existent files from structure tree (db_util.py, data_loader.py, screenshots/, api_scenarios.py, api_interface.md)
  • Replace Jenkins CI/CD references with GitHub Actions
  • Remove DB layer from architecture diagram
  • Delete Jenkins CI/CD integration section
  • Fix run commands (add -n 0 for UI tests, correct API host)

Test Plan

  • Verify structure tree matches actual files on disk
  • Verify all run commands are accurate

Closes #14

@ConnorQi01 ConnorQi01 changed the title docs: update README to reflect actual project structure [Documentation] Update README to reflect actual project structure Apr 28, 2026
@JunchenMeteor
JunchenMeteor merged commit 5109f29 into JunchenMeteor:main Apr 28, 2026
1 check passed
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.

[Documentation] Update README to reflect actual project structure

2 participants