diff --git a/README.md b/README.md index 9ea78d0..0be99fd 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ Repository: https://git.cs.bham.ac.uk/projects-2025-26/vxn217 - [Project Goals](#project-goals) - [Tech Stack](#tech-stack) - [Repository Guide](#repository-guide) +- [Notable Branches](#notable-branches) - [Evaluation Credentials](#evaluation-credentials) - [Recommended Evaluation Walkthrough](#recommended-evaluation-walkthrough) - [Local Setup (Cross-Platform)](#local-setup-cross-platform) @@ -58,23 +59,21 @@ Evaluation-relevant themes represented in the codebase: ## Screenshots -Placeholder slots for final screenshots. - ### Home Page -![Home Page Placeholder](docs/images/home-page-placeholder.png) +![Home Page](docs/images/home-page.png) ### Organization Page -![Organization Page Placeholder](docs/images/organization-page-placeholder.png) +![Organization Page](docs/images/organization-page.png) ### Onboarding Loading / Generation State -![Onboarding Loading Placeholder](docs/images/onboarding-loading-placeholder.png) +![Onboarding Loading](docs/images/onboarding-loading-page.png) ### Onboarding Content Flow -![Onboarding Flow Placeholder](docs/images/onboarding-flow-placeholder.png) +![Onboarding Flow](docs/images/onboarding-content-page.png) --- @@ -126,6 +125,22 @@ For a more detailed breakdown: --- +## Notable Branches + +These remote branches are useful for understanding how the project evolved: + +- `origin/main`: stable integration branch used for the current baseline. +- `origin/feature/node-setup`: early full-stack setup work introducing the initial frontend/backend server shape. +- `origin/feature/agents`: branch focused on agent-related backend changes, including pgvector-oriented database work. +- `origin/feature/mcp-workflow`: workflow iteration branch around MCP/testing flow changes. +- `origin/feature/model-rag`: branch associated with the model/RAG stream and related frontend scaffolding during that phase. + +Run `git branch -r` to view all remote branches. + +However, the main branch will be the primary focus as a lot of the code contained in the feature branches was used for testing different approaches and iterations, which then got consolidated or removed as the project evolved. The code in these branches may not be in a fully working state, and some of the approaches explored there were ultimately not used in the final implementation. + +--- + ## Evaluation Credentials | Role | Email | Password | diff --git a/docs/images/home-page.png b/docs/images/home-page.png new file mode 100644 index 0000000..523f85d Binary files /dev/null and b/docs/images/home-page.png differ diff --git a/docs/images/onboarding-content-page.png b/docs/images/onboarding-content-page.png new file mode 100644 index 0000000..180efab Binary files /dev/null and b/docs/images/onboarding-content-page.png differ diff --git a/docs/images/onboarding-loading-page.png b/docs/images/onboarding-loading-page.png new file mode 100644 index 0000000..292c7fd Binary files /dev/null and b/docs/images/onboarding-loading-page.png differ diff --git a/docs/images/organization-page.png b/docs/images/organization-page.png new file mode 100644 index 0000000..353cc98 Binary files /dev/null and b/docs/images/organization-page.png differ