Skip to content

Commit bab3827

Browse files
authored
docs: update docs (#48)
1 parent 85d763c commit bab3827

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A Python package to generate professional LeetCode practice environments. Featur
1111

1212
**What makes this different:**
1313

14-
- 🤖 **[LLM-Assisted Workflow](#llm-assisted-problem-creation)**: Generate new problems instantly with AI assistance
14+
- 🤖 **[LLM-Assisted Workflow](https://github.com/wisarootl/leetcode-py#llm-assisted-problem-creation)**: Generate new problems instantly with AI assistance
1515
- 🎨 **Visual Debugging**: Interactive tree/graph rendering with Graphviz and anytree
1616
- 🧪 **Production Testing**: Comprehensive test suites with edge cases and reproducibility verification
1717
- 🚀 **Modern Python**: PEP 585/604 type hints, Poetry, and professional tooling
@@ -55,11 +55,11 @@ python -m pytest test_solution.py # Run tests
5555
lcpy gen --problem-tag grind-75 --output leetcode # Generate all Grind 75 problems
5656
```
5757

58-
![Problem Generation](docs/images/problems-generation.png)
58+
![Problem Generation](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/problems-generation.png)
5959

6060
_Bulk generation output showing "Generated problem:" messages for all 75 Grind problems_
6161

62-
![Problem Generation 2](docs/images/problems-generation-2.png)
62+
![Problem Generation 2](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/problems-generation-2.png)
6363

6464
_Generated folder structure showing all 75 problem directories after command execution_
6565

@@ -77,19 +77,19 @@ leetcode/two_sum/
7777
└── __init__.py # Package marker
7878
```
7979

80-
![README Example](docs/images/readme-example.png)
80+
![README Example](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/readme-example.png)
8181

8282
_README format that mirrors LeetCode's problem description layout_
8383

84-
![Solution Boilerplate](docs/images/solution-boilerplate.png)
84+
![Solution Boilerplate](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/solution-boilerplate.png)
8585

8686
_Solution boilerplate with type hints and TODO placeholder_
8787

88-
![Test Example](docs/images/test-example.png)
88+
![Test Example](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/test-example.png)
8989

9090
_Comprehensive parametrized tests with 10+ test cases - executable and debuggable in local development environment_
9191

92-
![Test Logging](docs/images/logs-in-test-solution.png)
92+
![Test Logging](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/logs-in-test-solution.png)
9393

9494
_Beautiful colorful test output with loguru integration for enhanced debugging and test result visualization_
9595

@@ -114,21 +114,21 @@ Professional-grade visualization for debugging complex data structures with dual
114114

115115
#### Jupyter Notebook Integration (HTML Rendering)
116116

117-
![Tree Visualization](docs/images/tree-viz.png)
117+
![Tree Visualization](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/tree-viz.png)
118118

119119
_Interactive tree visualization using Graphviz SVG rendering in Jupyter notebooks_
120120

121-
![LinkedList Visualization](docs/images/linkedlist-viz.png)
121+
![LinkedList Visualization](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/linkedlist-viz.png)
122122

123123
_Professional linked list visualization with Graphviz in Jupyter environment_
124124

125125
#### Terminal/Console Output (String Rendering)
126126

127-
![Tree String Visualization](docs/images/tree-str-viz.png)
127+
![Tree String Visualization](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/tree-str-viz.png)
128128

129129
_Clean ASCII tree rendering using anytree for terminal debugging and logging_
130130

131-
![LinkedList String Visualization](docs/images/linkedlist-str-viz.png)
131+
![LinkedList String Visualization](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/linkedlist-str-viz.png)
132132

133133
_Simple arrow-based list representation for console output and test debugging_
134134

@@ -139,7 +139,7 @@ _Simple arrow-based list representation for console output and test debugging_
139139
- **Repository State**: This repo converts them to Python files (`.py`) for better version control
140140
- **Dual Rendering**: Automatic HTML visualization in notebooks, clean string output in terminals
141141

142-
![Notebook Example](docs/images/notebook-example.png)
142+
![Notebook Example](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/notebook-example.png)
143143

144144
_Interactive multi-cell playground with rich data structure visualization for each problem_
145145

@@ -189,7 +189,7 @@ make gen-all-problems
189189

190190
To extend the problem collection beyond the current catalog, leverage an LLM assistant within your IDE (Cursor, GitHub Copilot Chat, Amazon Q, etc.).
191191

192-
📖 **[Complete LLM-Assisted Problem Creation Guide](docs/llm-assisted-problem-creation.md)** - Comprehensive guide with screenshots and detailed workflow.
192+
📖 **[Complete LLM-Assisted Problem Creation Guide](https://github.com/wisarootl/leetcode-py/blob/main/docs/llm-assisted-problem-creation.md)** - Comprehensive guide with screenshots and detailed workflow.
193193

194194
**Quick Start:**
195195

@@ -205,8 +205,8 @@ To extend the problem collection beyond the current catalog, leverage an LLM ass
205205

206206
**Required LLM Context**: Include these rule files in your LLM context for automated problem generation and test enhancement:
207207

208-
- [`.amazonq/rules/problem-creation.md`](.amazonq/rules/problem-creation.md) - Complete problem generation workflow
209-
- [`.amazonq/rules/test-quality-assurance.md`](.amazonq/rules/test-quality-assurance.md) - Test enhancement and reproducibility verification
208+
- [`.amazonq/rules/problem-creation.md`](https://github.com/wisarootl/leetcode-py/blob/main/.amazonq/rules/problem-creation.md) - Complete problem generation workflow
209+
- [`.amazonq/rules/test-quality-assurance.md`](https://github.com/wisarootl/leetcode-py/blob/main/.amazonq/rules/test-quality-assurance.md) - Test enhancement and reproducibility verification
210210

211211
**Manual Check**: Find problems needing more test cases:
212212

@@ -244,7 +244,7 @@ poetry run python -m leetcode_py.tools.check_test_cases --threshold=10
244244

245245
### CLI Commands (Global)
246246

247-
📖 **[Complete CLI Usage Guide](docs/cli-usage.md)** - Detailed documentation with all options and examples.
247+
📖 **[Complete CLI Usage Guide](https://github.com/wisarootl/leetcode-py/blob/main/docs/cli-usage.md)** - Detailed documentation with all options and examples.
248248

249249
```bash
250250
# Generate problems

docs/llm-assisted-problem-creation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Configure your IDE with an LLM assistant:
3131

3232
Simply ask your LLM assistant to add a problem:
3333

34-
![Prompt with Context](images/prompt-with-context.png)
34+
![Prompt with Context](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/prompt-with-context.png)
3535

3636
_Example prompt showing how to request a new problem with the LLM assistant_
3737

@@ -53,7 +53,7 @@ The LLM assistant will execute the complete workflow:
5353
5. **Generate** complete problem structure in `leetcode/{problem_name}/`
5454
6. **Verify** with linting checks (iterates from step 3 until all pass)
5555

56-
![Problems Are Generated](images/problems-are-generated.png)
56+
![Problems Are Generated](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/problems-are-generated.png)
5757

5858
_Source control view showing all files created and modified during the problem generation process_
5959

@@ -63,15 +63,15 @@ _Source control view showing all files created and modified during the problem g
6363

6464
The assistant generates a clean solution template with proper type hints:
6565

66-
![Generated Solution](images/generated-solution.png)
66+
![Generated Solution](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/generated-solution.png)
6767

6868
_Generated solution.py file with TODO placeholder and proper method signature_
6969

7070
### Comprehensive Test Suite
7171

7272
Each problem includes 10+ test cases covering edge cases (note: generated test cases may need verification for correctness):
7373

74-
![Generated Test](images/generated-test.png)
74+
![Generated Test](https://raw.githubusercontent.com/wisarootl/leetcode-py/main/docs/images/generated-test.png)
7575

7676
_Generated test_solution.py with parametrized tests and comprehensive test cases_
7777

0 commit comments

Comments
 (0)