Skip to content

Commit eb37d85

Browse files
committed
docs: update readme, logs and prd
1 parent 90a9db4 commit eb37d85

5 files changed

Lines changed: 38 additions & 18 deletions

File tree

Implementation.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,31 @@ Go back through Phases 2–7 and make sure every case in the PRD's error table i
114114

115115
---
116116

117-
## Phase 11 — QA Pass
117+
## Phase 11 — Sync Past Submissions
118+
119+
1. Implement GraphQL/API scraping to fetch all previously "Accepted" submissions from LeetCode.
120+
2. Inject scraping script into a foreground tab to securely use CSRF cookies.
121+
3. Batch queue these historical solutions through the `sync-engine` to prevent duplicate spam and handle rate limiting gracefully.
122+
123+
---
124+
125+
## Phase 12 — Multi Platform Support
126+
127+
1. Refactor or extend `PlatformAdapter` to handle sites like GeeksForGeeks or HackerRank.
128+
2. Implement specific `GeeksForGeeksAdapter` including DOM observation and code extraction.
129+
3. Update Options UI so users can select which platforms to sync from.
130+
131+
---
132+
133+
## Phase 13 — QA Pass
118134

119135
1. Manual test matrix: multiple languages, all 3 difficulties, all 4 folder structures, re-submission (duplicate + version-bump paths), rate-limit simulation (mock 403 response), token revocation mid-session.
120136
2. Memory/perf sanity check — nothing in this PRD's original targets was load-bearing, but do confirm the popup doesn't lag and the content script isn't leaking listeners on SPA navigation (LeetCode is a SPA — watch for content script re-injection issues across problem navigations).
121137
3. Fresh-profile install test — the exact first-run flow a new user hits, no dev-console assists.
122138

123139
---
124140

125-
## Phase 12 — Chrome Web Store Packaging
141+
## Phase 14 — Chrome Web Store Packaging
126142

127143
1. Write the store listing emphasizing the security model (fine-grained PAT, single repo, no OAuth, no telemetry) — this is your actual differentiator, lead with it.
128144
2. Privacy policy page (even a static one) — required for Web Store listing, and directly reinforces the trust positioning from your Guiding Philosophy section.
@@ -142,11 +158,13 @@ Phase 4 → sync engine (joins 1+2+3)
142158
Phase 5 → README generator
143159
Phase 6 → commit templating
144160
Phase 7 → retry queue
145-
Phase 8 → popup UI
146-
Phase 9 → options page
147-
Phase 10 → error handling pass
148-
Phase 11 → QA
149-
Phase 12 → Web Store packaging
161+
Phase 8 → GitHub Actions CI
162+
Phase 9 → popup UI
163+
Phase 10 → options page
164+
Phase 11 → sync past submissions
165+
Phase 12 → multi platform support
166+
Phase 13 → error handling & QA
167+
Phase 14 → Web Store packaging
150168
```
151169

152170
Phases 2 and 3 can be built in parallel (or in either order) since neither depends on the other — they only meet at Phase 4. Everything from Phase 5 onward is strictly sequential.

PRD.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -259,13 +259,11 @@ Users can change repository, disconnect repository, or switch repositories.
259259

260260
# 8. V1.5 / V2 Features
261261

262-
## Import Existing History
262+
## Import Existing History (Moved to V1)
263263

264264
Fetch all past accepted submissions and upload them retroactively, using the same `_v1`, `_v2` suffix scheme for any problem with multiple historical submissions.
265265

266-
*(Deferred from V1 — not required to prove the core detect → commit → README loop; adds meaningfully to initial scope and GitHub API load.)*
267-
268-
## Multi Platform
266+
## Multi Platform (Moved to V1)
269267

270268
LeetCode, GeeksforGeeks, Codeforces, CodeChef, HackerRank, AtCoder
271269

@@ -424,9 +422,9 @@ Repository, Folder Structure, README, Commit Template, Retry Queue, Advanced
424422

425423
# 16. Roadmap
426424

427-
**V1** — LeetCode, GitHub Sync, README, PAT, Logs, Retry Queue, Duplicate Detection, Version History (`_v1`/`_v2` suffixing)
425+
**V1** — LeetCode, GitHub Sync, README, PAT, Logs, Retry Queue, Duplicate Detection, Version History, Import Existing History, Multi Platform (GeeksForGeeks, HackerRank)
428426

429-
**V1.5 / V2**Import Existing History, Multiple Platforms, Statistics Dashboard, Study Notes, Revision Planner, Multi-language Solutions, AI Explanation
427+
**V1.5 / V2** — Statistics Dashboard, Study Notes, Revision Planner, Multi-language Solutions, AI Explanation
430428

431429
**V3 (not scoped)** — Plugin Marketplace, Self-hosted Sync, VS Code Companion, Mobile Companion — revisit after V2 ships, no commitments made in this document.
432430

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
- By Language (`javascript/1-two-sum.js`)
1515
- Flat structure
1616
- **Duplicate Detection**: Intelligently hashes your code to prevent spamming your repo with identical submissions if you click "Submit" multiple times.
17+
- **Offline Retry Queue**: If your internet drops or GitHub's API rate limits you, your submissions are safely stored in a local queue and automatically retried later.
18+
- **Popup Dashboard**: Click the extension icon to view your sync status, see detailed logs, and manage any pending commits directly from the queue.
1719
- **Smart Versioning**: Optionally keep a history of your attempts (e.g., `_v1`, `_v2`) or choose to overwrite them in place.
1820
- **Auto-generated README**: Automatically maintains a markdown table and difficulty stats right in your repository.
1921
- **File Headers**: Automatically prepends metadata (Title, Difficulty, Runtime, Memory, LeetCode URL) to every uploaded file.

WORK_LOG/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
- [x] Phase 5: README Generator (`src/github/readme-generator.ts`)
2828
- [x] Phase 6: Commit Templating & Batched Commits via Git Database API
2929
- [x] Phase 7: Retry Queue & Popup Dashboard Management
30-
- [x] Phase 8 & 9: Popup UI and Options Page (`src/popup`, `src/options`)
30+
- [x] Phase 8: GitHub Actions CI/CD Release Pipeline
31+
- [x] Phase 9 & 10: Popup UI and Options Page (`src/popup`, `src/options`)
3132
- [x] Rebranding & Git History Rewrite: Renamed project to CommitCode, rebuilt Git history, expanded `README.md`.
3233
### Details
3334
**Phase 4: Sync Engine**

WORK_LOG/CURRENT_FOCUS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Current Focus
22

3-
Phase 8 — Advanced: GitHub Actions / CI Integration (Optional/Exploratory)
4-
- Evaluate whether we want to provide users with a pre-built GitHub Action to automatically run tests or update their README in the repo itself.
5-
- Consider polishing the codebase for public release (e.g., removing debug logs, checking edge cases).
6-
- Ensure all previously built phases are perfectly stable.
3+
Phase 11 — The "Holy Grail": Sync Past Submissions
4+
- We need a mechanism to fetch the user's entire LeetCode submission history.
5+
- Add a "Sync All Previous Submissions" button in the Options page.
6+
- Need to parse history via LeetCode GraphQL API.
7+
- Need to batch process them and send them to the SyncEngine.

0 commit comments

Comments
 (0)