docs: improve docs

wislertt · wislertt · commit 61dea9827614 · 2025-09-17T08:51:07.000+07:00
diff --git a/README.md b/README.md
@@ -4,13 +4,26 @@
 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wisarootl_leetcode-py&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wisarootl_leetcode-py)
 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=wisarootl_leetcode-py&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=wisarootl_leetcode-py)
 [![codecov](https://codecov.io/gh/wisarootl/leetcode-py/graph/badge.svg?token=TI97VUIA4Z)](https://codecov.io/gh/wisarootl/leetcode-py)
-[![tests](https://img.shields.io/github/actions/workflow/status/wisarootl/leetcode-py/ci-test.yml?branch=main&label=tests&logo=github)](https://github.com/wisarootl/zerv/actions/workflows/ci-test.yml)
-[![release](https://img.shields.io/github/actions/workflow/status/wisarootl/leetcode-py/cd.yml?branch=main&label=release&logo=github)](https://github.com/wisarootl/zerv/actions/workflows/cd.yml)
+[![tests](https://img.shields.io/github/actions/workflow/status/wisarootl/leetcode-py/ci-test.yml?branch=main&label=tests&logo=github)](https://github.com/wisarootl/leetcode-py/actions/workflows/ci-test.yml)
+[![release](https://img.shields.io/github/actions/workflow/status/wisarootl/leetcode-py/cd.yml?branch=main&label=release&logo=github)](https://github.com/wisarootl/leetcode-py/actions/workflows/cd.yml)
 [![downloads](https://static.pepy.tech/personalized-badge/leetcode-py-sdk?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=pypi%20downloads)](https://pepy.tech/projects/leetcode-py-sdk)
 [![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-brightgreen?logo=python)](https://pypi.org/project/leetcode-py-sdk/)
 
 A Python package to generate professional LeetCode practice environments. Features automated problem generation from LeetCode URLs, beautiful data structure visualizations (TreeNode, ListNode, GraphNode), and comprehensive testing with 10+ test cases per problem. Built with professional development practices including CI/CD, type hints, and quality gates.
 
+## Table of Contents
+
+- [What's Included](#-whats-included)
+- [Quick Start](#-quick-start)
+- [Problem Structure](#-problem-structure)
+- [Key Features](#-key-features)
+- [Usage Patterns](#-usage-patterns)
+- [Helper Classes](#-helper-classes)
+- [Commands](#️-commands)
+- [Development Setup](#️-development-setup)
+- [Architecture](#️-architecture)
+- [Quality Metrics](#-quality-metrics)
+
 **What makes this different:**
 
 - 🤖 **[LLM-Assisted Workflow](https://github.com/wisarootl/leetcode-py/blob/main/docs/llm-assisted-problem-creation.md)**: Generate new problems instantly with AI assistance
@@ -30,15 +43,12 @@ A Python package to generate professional LeetCode practice environments. Featur
 
 ### System Requirements
 
-- **Python 3.13+** - Modern Python runtime with latest type system features
-- **Poetry** - Dependency management and packaging
-- **Make** - Build automation (development workflows)
-- **Git** - Version control system
-- **Graphviz** - Graph visualization library (for data structure rendering)
+- **Python 3.10+** - Python runtime
+- **Graphviz** - Graph visualization library ([install guide](https://graphviz.org/download/))
 
 ```bash
 # Install the package
-pip install leetcode-py
+pip install leetcode-py-sdk
 
 # Generate problems anywhere
 lcpy gen -n 1                    # Generate Two Sum
@@ -150,30 +160,20 @@ _Interactive multi-cell playground with rich data structure visualization for ea
 
 ### CLI Usage (Global Installation)
 
-Perfect for quick problem generation anywhere:
-
-```bash
-# Generate specific problems
-lcpy gen -n 1 -n 125 -n 206      # Multiple problems by number
-lcpy gen -s two-sum -s valid-palindrome  # Multiple problems by slug
-
-# Bulk generation
-lcpy gen -t grind-75              # All Grind 75 problems
-lcpy gen -t grind-75 -d Easy     # Only Easy problems from Grind 75
-
-# Explore available problems
-lcpy list                         # All problems
-lcpy list -t grind-75            # Filter by tag
-lcpy list -d Medium              # Filter by difficulty
-
-# Fetch problem data
-lcpy scrape -n 1 > two_sum.json  # Save problem data
-```
+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.
 
 ## 🛠️ Development Setup
 
 For working within this repository to generate additional LeetCode problems using LLM assistance:
 
+### Development Requirements
+
+- **Python 3.10+** - Modern Python runtime with latest type system features
+- **Poetry** - Dependency management and packaging
+- **Make** - Build automation (development workflows)
+- **Git** - Version control system
+- **Graphviz** - Graph visualization library ([install guide](https://graphviz.org/download/))
+
 ```bash
 # Clone repository for development
 git clone https://github.com/wisarootl/leetcode-py.git
diff --git a/docs/improvement-checklist.md b/docs/improvement-checklist.md
@@ -4,130 +4,27 @@
 
 ### README.md Critical Issues
 
-- [ ] **Fix badge links**: Update tests and release badges from `wisarootl/zerv` to `wisarootl/leetcode-py`
-- [ ] **Python version consistency**: Change "Python 3.13+" to "Python 3.10+" to match badge
-- [ ] **Fix pip install command**: Update from `pip install leetcode-py` to `pip install leetcode-py-sdk`
+- [x] **Fix badge links**: Update tests and release badges from `wisarootl/zerv` to `wisarootl/leetcode-py`
+- [x] **Python version consistency**: Change "Python 3.13+" to "Python 3.10+" to match badge
+- [x] **Fix pip install command**: Update from `pip install leetcode-py` to `pip install leetcode-py-sdk`
 
 ### Navigation & Structure
 
-- [ ] **Add Table of Contents**: Include TOC at top of README for better navigation
-- [ ] **Consolidate CLI sections**: Reduce redundancy between Quick Start, Usage Patterns, and CLI guide
-- [ ] **Reorganize sections**: Move Development Setup after CLI usage for better flow
+- [x] **Add Table of Contents**: Include TOC at top of README for better navigation
+- [x] **Consolidate CLI sections**: Reduce redundancy between Quick Start, Usage Patterns, and CLI guide
+- [x] **Reorganize sections**: Move Development Setup after CLI usage for better flow
 
 ## Content Enhancements
 
 ### README.md Improvements
 
-- [ ] **Add "Getting Started in 5 Minutes"**: Absolute minimum steps for new users
-- [ ] **Performance metrics**: Add statistics like "Generate 75 problems in under 30 seconds"
-- [ ] **User personas**: Different paths for beginner vs advanced developers
-- [ ] **Comparison table**: Compare with other LeetCode practice tools
-- [ ] **More concrete examples**: Show before/after of problem generation
-
-### CLI Usage Guide
-
-- [ ] **Add troubleshooting section**: Common CLI errors and solutions
-- [ ] **Performance tips**: Best practices for bulk operations
-- [ ] **Combine multiple options**: Examples of complex CLI combinations
-- [ ] **Error handling examples**: Show specific error messages and fixes
+- [x] **Fix Quick Start system requirements**: Change from development requirements (Poetry/Make/Git) to CLI usage requirements (Python + Graphviz from https://graphviz.org/download/)
+- [x] **Move development system requirements**: Add proper development requirements to Development Setup section
 
 ### LLM-Assisted Problem Creation Guide
 
-- [ ] **Prerequisites checklist**: Clear setup requirements at top
 - [ ] **Test case verification**: Section on verifying generated test correctness
-- [ ] **More prompt examples**: Expand good vs bad prompt examples
-- [ ] **Integration examples**: Show how it fits into development workflow
 
 ### CONTRIBUTING.md
 
-- [ ] **Examples of contribution types**: Clarify "small changes" vs "larger changes"
-- [ ] **Link to issue templates**: Reference different contribution types
 - [ ] **Development workflow**: More detailed setup and testing instructions
-
-## New Documentation
-
-### Missing Documentation Files
-
-- [ ] **API Reference** (`docs/api-reference.md`): Document helper classes with examples
-    - TreeNode methods and usage
-    - ListNode methods and usage
-    - GraphNode methods and usage
-    - DictTree methods and usage
-- [ ] **Troubleshooting Guide** (`docs/troubleshooting.md`): Common issues and solutions
-- [ ] **FAQ** (`docs/faq.md`): Frequently asked questions
-- [ ] **Performance Guide** (`docs/performance.md`): Optimization tips and benchmarks
-
-### Enhanced Examples
-
-- [ ] **Data structure examples**: Concrete usage of TreeNode, ListNode, etc.
-- [ ] **Integration examples**: How to use with existing projects
-- [ ] **Advanced usage**: Complex scenarios and edge cases
-
-## Visual & Media
-
-### Image Consistency
-
-- [ ] **Standardize screenshots**: Ensure consistent IDE theme across all images
-- [ ] **Update outdated images**: Verify all screenshots reflect current UI
-- [ ] **Add missing visuals**: More examples of CLI output and generated files
-
-### Links & References
-
-- [ ] **Verify all links**: Check internal and external links work
-- [ ] **Add more references**: Link to LeetCode, Grind 75, related tools
-- [ ] **Fix image accessibility**: Ensure all images load correctly
-
-## Technical Improvements
-
-### SEO & Discoverability
-
-- [ ] **Improve meta descriptions**: Better GitHub search results
-- [ ] **Add keywords**: More searchable terms in descriptions
-- [ ] **Tag optimization**: Better categorization and tagging
-
-### Code Quality
-
-- [ ] **Code example validation**: Ensure all code snippets work
-- [ ] **Import statement examples**: Show correct import patterns
-- [ ] **Error handling**: Better error message examples
-
-## Organization & Maintenance
-
-### File Structure
-
-- [ ] **Organize docs folder**: Better categorization of documentation
-- [ ] **Cross-references**: Better linking between related docs
-- [ ] **Version consistency**: Ensure all docs reflect current version
-
-### Content Maintenance
-
-- [ ] **Regular review schedule**: Plan for keeping docs updated
-- [ ] **User feedback integration**: Process for incorporating user suggestions
-- [ ] **Automated checks**: Validate links and code examples in CI
-
-## Implementation Priority
-
-### Phase 1 (Immediate)
-
-1. Fix badge links
-2. Update Python version consistency
-3. Fix pip install command
-4. Add Table of Contents
-
-### Phase 2 (Short-term)
-
-1. Create API reference
-2. Add troubleshooting guide
-3. Enhance CLI documentation
-4. Improve visual consistency
-
-### Phase 3 (Long-term)
-
-1. Create comprehensive FAQ
-2. Add performance guide
-3. Develop user persona paths
-4. Build comparison resources
-
----
-
-**Note**: This checklist should be reviewed and updated regularly as the project evolves and user feedback is received.
