Skip to content

Commit 54e8df5

Browse files
lufftwclaude
andcommitted
fix(docs): Update outdated path references from packages/ to src/
- Fix code path references: packages/codegen -> src/codegen - Fix code path references: packages/leetcode_datasource -> src/leetcode_datasource - Fix code path references: packages/practice_workspace -> src/practice_workspace - Update script comments to reflect correct package location - Replace non-existent validate-tests/validate-e2e commands with check - Mark unimplemented commands in in-progress docs Files updated: - src/codegen/analyzer.py - scripts/new_problem.sh, new_problem.bat, new_practice.sh, new_practice.bat - docs/contracts/test-file-format.md - docs/contributors/docs-directory-organization.md - docs/contributors/package-documentation-strategy.md - docs/in-progress/new-problem-tests-autogen/migration-plan.md - docs/in-progress/new-problem-tests-autogen/specification.md - docs/in-progress/tiered-problem-generation/migration-plan.md - docs/in-progress/tiered-problem-generation/specification.md - docs/packages/leetcode_datasource/README.md - runner/utils/codec/README.md - tools/review-code/compare_html_parsers.py Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a93c5e6 commit 54e8df5

File tree

15 files changed

+53
-48
lines changed

15 files changed

+53
-48
lines changed

docs/contracts/test-file-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ false
274274
All test files must pass:
275275

276276
```bash
277-
python -m codegen validate-tests --all
277+
python -m codegen check --all
278278
```
279279

280280
Checks:

docs/contributors/docs-directory-organization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ This document defines the organization of the `docs/` directory, including folde
4141
|------|------------|---------|
4242
| Folders | `snake_case` or `kebab-case` | `leetcode_datasource/`, `two_pointers/` |
4343
| Files | `kebab-case.md` | `solution-contract.md` |
44-
| Package folders | Match package name exactly | `docs/packages/codegen/` matches `packages/codegen/` |
44+
| Package folders | Match package name exactly | `docs/packages/codegen/` matches `src/codegen/` |
4545

4646
### 1.3 Root-level Files
4747

@@ -253,9 +253,9 @@ System-level documentation for core modules. See [Package Documentation Strategy
253253
| Folder | Corresponds to |
254254
|--------|----------------|
255255
| `docs/runner/` | `runner/` |
256-
| `docs/packages/codegen/` | `packages/codegen/` |
257-
| `docs/packages/leetcode_datasource/` | `packages/leetcode_datasource/` |
258-
| `docs/packages/practice_workspace/` | `packages/practice_workspace/` |
256+
| `docs/packages/codegen/` | `src/codegen/` |
257+
| `docs/packages/leetcode_datasource/` | `src/leetcode_datasource/` |
258+
| `docs/packages/practice_workspace/` | `src/practice_workspace/` |
259259

260260
> ⚠️ **Important**: Package docs must be under `docs/packages/<pkg>/`, not `docs/<pkg>/`.
261261
> Scattered files like `docs/codegen.md` are NOT allowed.

docs/contributors/package-documentation-strategy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,11 +335,11 @@ The `runner/` module is the **reference implementation** for this documentation
335335

336336
```markdown
337337
<!-- BAD: Same content in both files -->
338-
packages/codegen/README.md: "## How It Works: Step 1, Step 2..."
338+
src/codegen/README.md: "## How It Works: Step 1, Step 2..."
339339
docs/packages/codegen/README.md: "## How It Works: Step 1, Step 2..."
340340

341341
<!-- GOOD: Different perspectives -->
342-
packages/codegen/README.md: "## Public API" (what to call)
342+
src/codegen/README.md: "## Public API" (what to call)
343343
docs/packages/codegen/README.md: "## Typical Workflows" (system-level flow)
344344
```
345345

docs/in-progress/new-problem-tests-autogen/migration-plan.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,9 @@ CI automation (when enabled) does not replace manual responsibility.
462462
#### Command
463463

464464
```bash
465-
python -m codegen validate-tests --all
465+
# Note: validate-tests was planned but not implemented
466+
# Using check command instead:
467+
python -m codegen check --all
466468
```
467469

468470
#### Pass Condition
@@ -660,7 +662,7 @@ Phase 6: solve_generator ◀── Phase 5: generators/ ◀── Phase 4: codeg
660662

661663
2. **Run Gate 0 validation**
662664
```bash
663-
python -m codegen validate-tests --all
665+
python -m codegen check --all
664666
```
665667

666668
3. **Review and commit**
@@ -745,8 +747,9 @@ Phase 6: solve_generator ◀── Phase 5: generators/ ◀── Phase 4: codeg
745747

746748
2. **Validate all Tier-0 problems**
747749
```bash
748-
# Run E2E validation script (to be created)
749-
python -m codegen validate-e2e --tier 0
750+
# Note: validate-e2e was planned but not implemented
751+
# Use check command instead:
752+
python -m codegen check --all
750753
```
751754

752755
3. **Verify unsupported types fail gracefully**
@@ -853,7 +856,7 @@ python -m codegen migrate --all --dry-run
853856
python -m codegen migrate --all
854857

855858
# Step 3: Validate
856-
python -m codegen validate-tests --all
859+
python -m codegen check --all
857860

858861
# Step 4: Run regression to ensure nothing broke
859862
python runner/test_runner.py --all
@@ -1017,7 +1020,7 @@ Prioritize by complexity:
10171020
| Task | Command |
10181021
|------|---------|
10191022
| Migrate tests | `python -m codegen migrate --all` |
1020-
| Validate tests | `python -m codegen validate-tests --all` |
1023+
| Validate tests | `python -m codegen check --all` |
10211024
| Run regression | `python runner/test_runner.py --all` |
10221025
| New problem + tests | `python -m codegen new <id> --with-tests` |
10231026
| Check consistency | `python -m codegen check <id>` |
@@ -1088,16 +1091,18 @@ python -m codegen migrate 0001_two_sum
10881091
python -m codegen migrate --all --no-backup
10891092
```
10901093
1091-
#### `codegen validate-tests`
1094+
#### `codegen validate-tests` (Not Implemented)
1095+
1096+
> **Note**: This command was planned but not implemented. Use `codegen check --all` instead for test file validation.
10921097
10931098
Validate test files against canonical format (Gate 0).
10941099
10951100
```bash
1096-
python -m codegen validate-tests [options]
1101+
# Planned command (not implemented):
1102+
# python -m codegen validate-tests [options]
10971103
1098-
Options:
1099-
--all Validate all test files
1100-
--verbose Show detailed output
1104+
# Use this instead:
1105+
python -m codegen check --all
11011106
```
11021107
11031108
#### `codegen check`
@@ -1260,7 +1265,7 @@ git checkout HEAD~1 -- generators/
12601265
12611266
#### Scenario 1: Gate 0 fails after migration
12621267
1263-
**Symptom:** `validate-tests` reports parse errors
1268+
**Symptom:** `codegen check` reports parse errors
12641269
12651270
**Recovery:**
12661271
1. Identify failing files from error output

docs/in-progress/new-problem-tests-autogen/specification.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This feature has been fully implemented with the following capabilities:
2020

2121
For complete documentation, see:
2222
- [CodeGen Package Docs](../../packages/codegen/README.md)
23-
- [Package README](../../../packages/codegen/README.md)
23+
- [Package README](../../../src/codegen/README.md)
2424

2525
---
2626

@@ -57,7 +57,7 @@ For complete documentation, see:
5757
@echo off
5858
setlocal EnableExtensions
5959
60-
REM Pass-through wrapper: all logic lives in packages/codegen
60+
REM Pass-through wrapper: all logic lives in src/codegen
6161
python -m codegen new %*
6262
exit /b %ERRORLEVEL%
6363
```
@@ -338,14 +338,14 @@ Summary: 1 solution, 0 test cases created
338338

339339
| Component | Location |
340340
|-----------|----------|
341-
| CLI entry point | `packages/codegen/cli.py` |
342-
| IO Schema inference | `packages/codegen/core/io_schema.py` |
343-
| Example parser | `packages/codegen/core/example_parser.py` |
344-
| Stub parser | `packages/codegen/core/stub_parser.py` |
345-
| solve() generator | `packages/codegen/core/solve_generator.py` |
346-
| Test generator | `packages/codegen/core/test_generator.py` |
347-
| Consistency checker | `packages/codegen/checker.py` |
348-
| Format migrator | `packages/codegen/migrator.py` |
341+
| CLI entry point | `src/codegen/cli.py` |
342+
| IO Schema inference | `src/codegen/core/io_schema.py` |
343+
| Example parser | `src/codegen/core/example_parser.py` |
344+
| Stub parser | `src/codegen/core/stub_parser.py` |
345+
| solve() generator | `src/codegen/core/solve_generator.py` |
346+
| Test generator | `src/codegen/core/test_generator.py` |
347+
| Consistency checker | `src/codegen/checker.py` |
348+
| Format migrator | `src/codegen/migrator.py` |
349349
| Windows wrapper | `scripts/new_problem.bat` |
350350

351351
---
@@ -571,7 +571,7 @@ python -m codegen.analyzer
571571

572572
| Component | Location |
573573
|-----------|----------|
574-
| Analyzer | `packages/codegen/analyzer.py` |
574+
| Analyzer | `src/codegen/analyzer.py` |
575575
| Report output | `docs/in-progress/new-problem-tests-autogen/mismatch-report.json` |
576576

577577
---

docs/in-progress/tiered-problem-generation/migration-plan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ encode_random_pointer_list(head) -> list
5252

5353
**New Structure**:
5454
```
55-
packages/codegen/core/catalog/
55+
src/codegen/core/catalog/
5656
├── __init__.py # Unified API
5757
├── registry.py # Metadata registry
5858
└── templates/
@@ -81,7 +81,7 @@ packages/codegen/core/catalog/
8181

8282
### 3.1 Create config reader utility ✅
8383

84-
**Location**: `packages/codegen/core/problem_support.py` (implemented)
84+
**Location**: `src/codegen/core/problem_support.py` (implemented)
8585

8686
All required functions are implemented:
8787
-`load_problem_config(problem_id: str) -> ProblemConfig`
@@ -92,7 +92,7 @@ All required functions are implemented:
9292

9393
### 3.2 Integrate with codegen ✅
9494

95-
**Updated**: `packages/codegen/reference/generator.py`
95+
**Updated**: `src/codegen/reference/generator.py`
9696
- ✅ Auto-detects tier from config
9797
- ✅ Automatically uses tiered mode for Tier-1/1.5 problems
9898
- ✅ Applies codec_mode logic (import vs inline)

docs/in-progress/tiered-problem-generation/specification.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@ IF tier == "1.5":
211211
| `docs/contracts/codec.md` | Codec package contract |
212212
| `config/problem-support.yaml` | Living registry |
213213
| `runner/utils/codec/` | **Single Source**: Runtime + inline templates |
214-
| `packages/codegen/core/catalog/` | AST extraction from codec/ |
215-
| `packages/codegen/core/problem_support.py` | Config reader utility |
216-
| `packages/codegen/core/tiered_solve_generator.py` | Tiered solve() generation |
214+
| `src/codegen/core/catalog/` | AST extraction from codec/ |
215+
| `src/codegen/core/problem_support.py` | Config reader utility |
216+
| `src/codegen/core/tiered_solve_generator.py` | Tiered solve() generation |
217217

218218
---
219219

@@ -231,8 +231,8 @@ IF tier == "1.5":
231231
- [x] Update `catalog/__init__.py` with AST extraction
232232

233233
### Phase 3: codegen Integration ✅
234-
- [x] Create `packages/codegen/core/problem_support.py` (config reader)
235-
- [x] Create `packages/codegen/core/tiered_solve_generator.py`
234+
- [x] Create `src/codegen/core/problem_support.py` (config reader)
235+
- [x] Create `src/codegen/core/tiered_solve_generator.py`
236236
- [x] Implement `codec_mode` logic (import vs inline)
237237
- [x] Add `--solve-mode=tiered` CLI option
238238
- [x] Add `--codec-mode` CLI option (override config)

docs/packages/leetcode_datasource/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ High-level summary of public APIs. For complete API reference, see [Package READ
128128
### Module Structure
129129

130130
```
131-
packages/leetcode_datasource/
131+
src/leetcode_datasource/
132132
├── __init__.py # Public API exports
133133
├── datasource.py # LeetCodeDataSource main class
134134
├── config.py # DataSourceConfig

runner/utils/codec/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This package provides codec functions to convert between simple `.in/.out` forma
2020

2121
- ❌ Problem-specific logic (handled by `solve()`)
2222
- ❌ Test comparison (handled by `runner/compare.py`)
23-
- ❌ Code generation (handled by `packages/codegen/`)
23+
- ❌ Code generation (handled by `src/codegen/`)
2424

2525
## Public API
2626

@@ -85,7 +85,7 @@ codec/
8585
| Direction | Module | Purpose |
8686
|-----------|--------|---------|
8787
| Used by → | `solutions/*.py` | Runtime codec |
88-
| Used by → | `packages/codegen/` | AST extraction for inline mode |
88+
| Used by → | `src/codegen/` | AST extraction for inline mode |
8989

9090
## Related Documentation
9191

@@ -100,5 +100,5 @@ codec/
100100

101101
1. Update this README (quick reference)
102102
2. Update `docs/contracts/codec.md` (contract)
103-
3. Update `packages/codegen/core/catalog/__init__.py` if adding new classes/functions
103+
3. Update `src/codegen/core/catalog/__init__.py` if adding new classes/functions
104104

scripts/new_practice.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ setlocal EnableExtensions
33

44
REM ============================================
55
REM Create Practice File (pass-through wrapper)
6-
REM All logic lives in packages/codegen
6+
REM All logic lives in src/codegen
77
REM
88
REM Usage:
99
REM new_practice.bat 23 Generate practice skeleton

0 commit comments

Comments
 (0)