code-doc-makerlisted

# Code Doc Maker ## Goal Keep this repository’s documentation **complete, navigable, and interview-friendly**, following the project’s conventions. ## Non‑negotiable rules (must follow) 1. **Root has everything**: The root `README.MD` must include links to every major content area and entry docs. 2. **Hand-writing structure**: For `hand-writing/` topics, write **思路 first**, then provide **code links** (implementation + tests when present). 3. **Basic notes rewrite**: For `basic/` topics, transform terse bullet points into **smooth, readable sentences** (still concise, still technically correct). ## Workflow (do this every time) ### 1) Inventory and gaps - List all Markdown files under repo (including `basic/`, `hand-writing/`, `algorithm/`). - Identify: - Missing index docs (e.g. a directory has content but no README/index). - Stale links (files moved/renamed). - Sections that are still “草稿/要点” and need rewriting. ### 2) Update root aggregation (`README.MD`) - Ensure `README.MD` contains: - Short purpose statement - Links to `basic/` docs - Link to `hand-writing/README.MD` - Link to `algorithm/` (and `algorithm/README` if it exists) - Minimal “how to run tests” section when relevant ### 3) Hand-writing docs (`hand-writing/README.MD` and topic docs) For each hand-writing problem: - **思路** must include: - Problem restatement (1–2 lines) - Key edge cases - Time/space complexity (if meaningful) - Common pitfalls - **代码链接** must include: - Imp