Skip to content

Commit dc201a3

Browse files
committed
docs: improve docs
1 parent 800410e commit dc201a3

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

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

1414
## Table of Contents
1515

16-
- [What's Included](#-whats-included)
17-
- [Quick Start](#-quick-start)
18-
- [Problem Structure](#-problem-structure)
19-
- [Key Features](#-key-features)
20-
- [Usage Patterns](#-usage-patterns)
21-
- [Helper Classes](#-helper-classes)
22-
- [Commands](#️-commands)
23-
- [Development Setup](#️-development-setup)
24-
- [Architecture](#️-architecture)
25-
- [Quality Metrics](#-quality-metrics)
16+
- [What's Included](#whats-included)
17+
- [Quick Start](#quick-start)
18+
- [Problem Structure](#problem-structure)
19+
- [Key Features](#key-features)
20+
- [Usage Patterns](#usage-patterns)
21+
- [Development Setup](#development-setup)
22+
- [Helper Classes](#helper-classes)
23+
- [Commands](#commands)
24+
- [Architecture](#architecture)
25+
- [Quality Metrics](#quality-metrics)
2626

2727
**What makes this different:**
2828

@@ -33,13 +33,13 @@ A Python package to generate professional LeetCode practice environments. Featur
3333
- 📊 **Quality Assurance**: 95%+ test coverage, security scanning, automated linting
3434
-**[Powerful CLI](https://github.com/wisarootl/leetcode-py/blob/main/docs/cli-usage.md)**: Generate problems anywhere with `lcpy` command
3535

36-
## 🎯 What's Included
36+
## <a id="whats-included"></a>🎯 What's Included
3737

3838
**Current**: All 75 problems from [Grind 75](https://www.techinterviewhandbook.org/grind75/) - the most essential coding interview questions curated by the creator of Blind 75.
3939

4040
**Future**: Planned expansion to all free Grind problems for comprehensive interview preparation. [Contributions welcome!](CONTRIBUTING.md)
4141

42-
## 🚀 Quick Start
42+
## <a id="quick-start"></a>🚀 Quick Start
4343

4444
### System Requirements
4545

@@ -75,7 +75,7 @@ _Bulk generation output showing "Generated problem:" messages for all 75 Grind p
7575

7676
_Generated folder structure showing all 75 problem directories after command execution_
7777

78-
## 📁 Problem Structure
78+
## <a id="problem-structure"></a>📁 Problem Structure
7979

8080
Each problem follows a consistent, production-ready template:
8181

@@ -105,7 +105,7 @@ _Comprehensive parametrized tests with 10+ test cases - executable and debuggabl
105105

106106
_Beautiful colorful test output with loguru integration for enhanced debugging and test result visualization_
107107

108-
## ✨ Key Features
108+
## <a id="key-features"></a>✨ Key Features
109109

110110
### Production-Grade Development Environment
111111

@@ -155,13 +155,13 @@ _Simple arrow-based list representation for console output and test debugging_
155155

156156
_Interactive multi-cell playground with rich data structure visualization for each problem_
157157

158-
## 🔄 Usage Patterns
158+
## <a id="usage-patterns"></a>🔄 Usage Patterns
159159

160160
### CLI Usage (Global Installation)
161161

162162
Perfect for quick problem generation anywhere. See the 📖 **[Complete CLI Usage Guide](https://github.com/wisarootl/leetcode-py/blob/main/docs/cli-usage.md)** for detailed documentation with all options and examples.
163163

164-
## 🛠️ Development Setup
164+
## <a id="development-setup"></a>🛠️ Development Setup
165165

166166
For working within this repository to generate additional LeetCode problems using LLM assistance:
167167

0 commit comments

Comments
 (0)