Skip to content

Commit fbf762b

Browse files
committed
Refactor documentation and remove obsolete files
- Updated main README to direct users to the project root for full documentation. - Consolidated backend and frontend README files into the main documentation. - Changed frontend installation commands from Yarn to NPM in agent instructions. - Deleted outdated backend and frontend README files to streamline documentation. - Removed symmetry-unified-backend README to centralize information in the main README.
1 parent 522c0fe commit fbf762b

9 files changed

Lines changed: 447 additions & 7638 deletions

File tree

README.md

Lines changed: 441 additions & 14 deletions
Large diffs are not rendered by default.

desktop-electron-frontend/README.md

Lines changed: 0 additions & 546 deletions
This file was deleted.

desktop-electron-frontend/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@
6767
"tailwind-merge": "^2.3.0",
6868
"tailwindcss-animate": "^1.0.7"
6969
},
70-
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
7170
"overrides": {
7271
"tar": "^7.5.11",
7372
"tmp": "^0.2.4",

desktop-electron-frontend/yarn.lock

Lines changed: 0 additions & 6271 deletions
This file was deleted.

docs/README.md

Lines changed: 3 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -1,176 +1,13 @@
11
# Project Symmetry — Documentation
22

3-
Cross-language Wikipedia article gap analysis tool.
3+
> The main README at the project root contains the full documentation (setup, architecture, API reference, CI/CD, contributing).
4+
> See [../README.md](../README.md).
45
56
---
67

7-
## Documents
8+
## Additional Documents
89

910
| File | Description |
1011
|------|-------------|
11-
| [backend/README.md](./backend/README.md) | Backend API reference, architecture, configuration |
12-
| [frontend/README.md](./frontend/README.md) | Frontend architecture, project structure, development |
1312
| [similarity-threshold-algorithm.md](./similarity-threshold-algorithm.md) | Complete similarity scoring algorithm documentation (prototype + production) |
1413
| [agent-instructions.md](./agent-instructions.md) | LLM/agent development instructions, conventions, pitfalls |
15-
16-
---
17-
18-
## Overview
19-
20-
**A semantic analysis tool that compares Wikipedia articles across languages section-by-section and paragraph-by-paragraph to identify content gaps, missing information, and added content.**
21-
22-
Repository: [grey-box/symmetry-project](https://github.com/grey-box/symmetry-project)
23-
24-
![CI](https://github.com/grey-box/symmetry-project/actions/workflows/ci.yml/badge.svg) ![Release](https://github.com/grey-box/symmetry-project/actions/workflows/release.yml/badge.svg) ![Latest Release](https://img.shields.io/github/v/release/grey-box/symmetry-project)
25-
26-
---
27-
28-
## Tech Stack
29-
30-
| Layer | Technologies |
31-
|-------|-------------|
32-
| Frontend | Electron 26 + React 18 + TypeScript + Vite + Tailwind CSS + shadcn/ui |
33-
| Backend | Python + FastAPI + sentence-transformers + spaCy + MarianMT |
34-
| Comparison Engine | LaBSE sentence embeddings (cosine similarity) + Levenshtein distance |
35-
36-
---
37-
38-
## Prerequisites
39-
40-
- Node.js v18+
41-
- Python 3.8–3.11
42-
- yarn / npm
43-
- Docker (optional, for containerized deployment)
44-
45-
---
46-
47-
## Quick Start
48-
49-
### Unified Script (Recommended)
50-
51-
```bash
52-
# Start both backend and frontend
53-
./start.sh all
54-
55-
# Start with frontend in development mode
56-
./start.sh all --dev
57-
```
58-
59-
### Docker Compose
60-
61-
```bash
62-
./start.sh docker # Foreground
63-
./start.sh docker-up # Detached
64-
./start.sh docker-down # Stop
65-
```
66-
67-
### Manual — Backend
68-
69-
```bash
70-
cd symmetry-unified-backend
71-
python3 -m venv venv
72-
source venv/bin/activate
73-
pip install -r requirements.txt
74-
uvicorn app.main:app --reload --host 127.0.0.1 --port 8000
75-
```
76-
77-
### Manual — Frontend
78-
79-
```bash
80-
cd desktop-electron-frontend
81-
yarn install
82-
yarn start
83-
```
84-
85-
---
86-
87-
## Access Points
88-
89-
- **Frontend**: <http://localhost:5173>
90-
- **Backend API**: <http://localhost:8000>
91-
- **API Documentation (Swagger)**: <http://localhost:8000/docs>
92-
93-
---
94-
95-
## Docker Images
96-
97-
Released images are available from GHCR:
98-
99-
```bash
100-
# Pull specific version
101-
docker pull ghcr.io/grey-box/symmetry-project/backend:1.1.0
102-
docker pull ghcr.io/grey-box/symmetry-project/frontend:1.1.0
103-
104-
# Pull latest
105-
docker pull ghcr.io/grey-box/symmetry-project/backend:latest
106-
docker pull ghcr.io/grey-box/symmetry-project/frontend:latest
107-
```
108-
109-
---
110-
111-
## API Endpoints Summary
112-
113-
### Section Comparison (Primary)
114-
115-
- `POST /symmetry/v1/articles/compare-sections` — Compare two Wikipedia articles section-by-section with paragraph-level diffs
116-
117-
### Structured Wiki
118-
119-
- `GET /symmetry/v1/wiki/structured-article` — Parse article into sections/citations/references
120-
121-
### Legacy Comparison
122-
123-
- `POST /symmetry/v1/articles/compare` — Plain-text semantic comparison
124-
125-
### Models Management
126-
127-
- `GET /models/comparison` — List comparison models
128-
129-
See [backend/README.md](./backend/README.md) for the full API reference.
130-
131-
---
132-
133-
## Testing
134-
135-
```bash
136-
cd symmetry-unified-backend
137-
source venv/bin/activate
138-
python -m pytest # Run all tests
139-
python -m pytest -v # Verbose
140-
python -m pytest --cov=app # With coverage
141-
```
142-
143-
---
144-
145-
## CI/CD
146-
147-
GitHub Actions workflows:
148-
149-
| Workflow | Trigger | What it does |
150-
|----------|---------|-------------|
151-
| **CI** (`.github/workflows/ci.yml`) | Push/PR to `main` or `develop` | Runs backend tests, builds frontend web bundle, builds & smoke-tests frontend Docker image, runs docker-compose integration |
152-
| **Release** (`.github/workflows/release.yml`) | Push to `main` | Runs full CI → bumps version (semver) → creates git tag → creates GitHub release → publishes Docker images to GHCR |
153-
154-
---
155-
156-
## Contributing
157-
158-
1. Fork the repository
159-
2. Create a feature branch (`git checkout -b feature/your-feature`)
160-
3. Install dependencies (see Quick Start above)
161-
4. Make changes and run tests
162-
5. Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
163-
6. Submit a pull request to `develop`
164-
7. After review, PRs are merged to `develop`, then promoted to `main` for release
165-
166-
---
167-
168-
## Community
169-
170-
- **Project Website**: <https://www.grey-box.ca/project-symmetry/>
171-
- **GitHub Issues**: <https://github.com/grey-box/Project-Symmetry-AI/issues>
172-
- **Design Resources (Figma)**: <https://www.figma.com/design/yN89gDcV3rdbje70X9RJGL/Project-Symmetry>
173-
174-
---
175-
176-
**Last Updated**: April 2026 | **Version**: 2.0.0 | **Maintainers**: [grey-box](https://github.com/grey-box)

docs/agent-instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ python -m pytest -v --tb=short # verbose with short tracebacks
3333

3434
```bash
3535
cd desktop-electron-frontend
36-
yarn install
37-
yarn start # dev mode
38-
yarn build # production build
36+
npm install
37+
npm start # dev mode
38+
npm run build # production build
3939
```
4040

4141
---

docs/backend/README.md

Lines changed: 0 additions & 176 deletions
This file was deleted.

0 commit comments

Comments
 (0)