Skip to content

Commit f4da6b6

Browse files
committed
Docs: Update README to reflect Codex UI migration and new features
1 parent acc35c8 commit f4da6b6

1 file changed

Lines changed: 7 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ As featured on [Wikimedia Diff](https://diff.wikimedia.org/2026/04/14/introducin
2020
- **🌳 Granular Structural Filtering**: High-precision extraction and filtering of **Functions**, **Types**, **Template Functions**, and **Template Types** across 10 languages.
2121
- **🏗️ Split-Build Architecture**: Optimized for asymmetric hardware—run heavy extraction on a laptop and neural vectorization on a GPU.
2222
- **🌍 Massive Localization Footprint**: Fully localized UI supporting **17 languages**.
23-
- **🌌 Octahedron Vortex UI**: A visually stunning frontend built with React and Three.js.
23+
- **🎨 Codex UI**: A clean, accessible frontend built with Wikimedia's **Codex Design System** for a native look and feel.
24+
- **🔍 Advanced Multi-select Filtering**: Granular control over results by repository group, programming language, and entry type.
2425

2526
## 🚀 Scaling & Pipeline
2627

@@ -40,15 +41,11 @@ source venv/bin/activate
4041
pip install -r requirements.txt
4142
```
4243

43-
### Frontend (Node.js)
44+
### Frontend (Static Assets)
4445

45-
To compile the React application, you will need Node.js installed on your machine. **This step is mandatory** for local development as the compiled `app.js` is excluded from the repository.
46+
The frontend is built with vanilla JavaScript and the Codex Design System. It consists of static HTML, CSS, and JS files located in the `frontend/` directory. These files are served directly by the FastAPI backend.
4647

47-
Install the dependencies and run the build:
48-
```bash
49-
npm install # This also runs 'npm run build' automatically via postinstall
50-
```
51-
This generates the pre-compiled `frontend/js/app.js` required by the application.
48+
There is no compilation step required for the frontend.
5249

5350
### Phase 1: Discovery & Mirroring (Local)
5451
First, discover the ecosystem and mirror it for processing:
@@ -101,7 +98,7 @@ cd backend
10198
python migrate_to_sqlite.py
10299
```
103100

104-
Once the index and database are ready, and the **frontend has been compiled** (see above), start the FastAPI backend from the root directory:
101+
Once the index and database are ready, start the FastAPI backend from the root directory:
105102

106103
```bash
107104
# From the project root
@@ -169,7 +166,7 @@ toolforge webservice logs -f
169166
- **Vector Engine**: [FAISS](https://github.com/facebookresearch/faiss) (IndexIVFPQ for memory efficiency)
170167
- **Segmentation**: [Tree-sitter](https://tree-sitter.github.io/tree-sitter/)
171168
- **Archive Access**: [Software Heritage](https://archive.softwareheritage.org/)
172-
- **Frontend**: React 18 / Three.js
169+
- **Frontend**: Vanilla JavaScript / [Codex Design System](https://doc.wikimedia.org/codex/main/)
173170

174171

175172
## 📄 Licence

0 commit comments

Comments
 (0)