divyap/thob-capability-map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clean up README for clarity and simplicity

Browse Source
This commit is contained in:
divyap 2026-03-31 00:29:06 +05:30
parent 9c307ed504
commit 64fbf7effa
1 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -44,7 +44,7 @@ The repository is organized by "Weeks," with each week containing multiple task
--- ---
## 🛠️ Tech Stack ## Tech Stack
* **Engine**: Three.js * **Engine**: Three.js
* **Frontend**: React (for R3F) * **Frontend**: React (for R3F)
* **Styling**: CSS Modules / Vanilla CSS * **Styling**: CSS Modules / Vanilla CSS
@ -53,7 +53,7 @@ The repository is organized by "Weeks," with each week containing multiple task
--- ---
## 🏁 Week 1 Milestone Summary ## Week 1 Milestone Summary
| Task | Capability | Vanilla | R3F | Thob Builder | | Task | Capability | Vanilla | R3F | Thob Builder |
| :--- | :--- | :--- | :--- | :--- | | :--- | :--- | :--- | :--- | :--- |
@ -62,42 +62,25 @@ The repository is organized by "Weeks," with each week containing multiple task
| **03** | Hover Interaction | Yes | Yes | Planned / Limited | | **03** | Hover Interaction | Yes | Yes | Planned / Limited |
| **04** | Click Toggle State | Yes | Yes | Unstable / Broken | | **04** | Click Toggle State | Yes | Yes | Unstable / Broken |
### 🔦 Key Week 1 Insights: ### Key Week 1 Insights:
* **Speed Advantage**: Thob Builder is exceptionally fast for **Static Visual Configuration**. Setting up meshes and textures in the UI is roughly **3-5x faster** than writing the equivalent boilerplate in code. * **Speed Advantage**: Thob Builder is exceptionally fast for **Static Visual Configuration**. Setting up meshes and textures in the UI is roughly **3-5x faster** than writing the equivalent boilerplate in code.
* **Interaction Gap**: The primary limitation currently identified is the **Interaction Engine**. Hover events and persistent state toggles (onClick) are currently unreliable or missing in the builder. * **Interaction Gap**: The primary limitation currently identified is the **Interaction Engine**. Hover events and persistent state toggles (onClick) are currently unreliable or missing in the builder.
--- ---
## 🚀 Getting Started ## Getting Started
### 📦 Installation
The project uses `yarn` for dependency management. The project uses `yarn` for dependency management.
```bash ```bash
# Clone the repository
git clone [repo-url]
# Install all dependencies (Monorepo root)
yarn install yarn install
``` ```
### 💻 Development Servers ### Dev Servers
To run any specific task implementation: To run any implementation:
```bash ```bash
# Example: Running Task 4 (R3F) cd Week-1/Task-[N]/[vanilla|r3f]
cd Week-1/Task-4/r3f
yarn dev yarn dev
``` ```
--- ---
## Contribution & Reporting **Sprint Lead**: Divya Pahuja | **Goal**: Identify the Interaction Threshold for Thob Builder.
Each task includes a **`report.md`** file. These reports follow a standardized format to capture:
* **Complexity**: How many lines of code vs. clicks?
* **Limitation Type**: Is it a runtime, editor, or UX issue?
* **Workarounds**: How did we solve the gap?
* **Business Value**: Why does this feature matter to our users?
---
**Sprint Lead**: Divya Pahuja
**Goal**: Identify the "Interactivity Threshold" where code becomes more efficient than the builder UI.