Added notable branches and demo screenshots
This commit is contained in:
parent
7d1ca3ebda
commit
7b5f78529b
5 changed files with 21 additions and 6 deletions
27
README.md
27
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
|
||||
|
||||

|
||||

|
||||
|
||||
### Organization Page
|
||||
|
||||

|
||||

|
||||
|
||||
### Onboarding Loading / Generation State
|
||||
|
||||

|
||||

|
||||
|
||||
### Onboarding Content Flow
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
|
|
@ -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 |
|
||||
|
|
|
|||
BIN
docs/images/home-page.png
Normal file
BIN
docs/images/home-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 316 KiB |
BIN
docs/images/onboarding-content-page.png
Normal file
BIN
docs/images/onboarding-content-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 113 KiB |
BIN
docs/images/onboarding-loading-page.png
Normal file
BIN
docs/images/onboarding-loading-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
BIN
docs/images/organization-page.png
Normal file
BIN
docs/images/organization-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
Loading…
Reference in a new issue