Skip to content

Commit 9e423d5

Browse files
committed
docs: consolidate tools documentation in tools/README.md
- Rewrite tools/README.md as comprehensive tools reference (~280 lines) - Delete docs/TOOLS.md to avoid duplication (was 345 lines) - Remove Tools from mkdocs.yml nav (developer docs don't belong in user website) - Update docs/MKDOCS_CONTENT_GUIDE.md to reflect new documentation structure This follows best practices: user docs in docs/, developer docs with code.
1 parent 852c6fe commit 9e423d5

File tree

4 files changed

+354
-373
lines changed

4 files changed

+354
-373
lines changed

docs/MKDOCS_CONTENT_GUIDE.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ Based on the `nav` configuration in `mkdocs.yml`, the following content is inclu
2929
| `docs/SOLUTION_CONTRACT.md` | Solution file specification | `https://lufftw.github.io/neetcode/SOLUTION_CONTRACT/` |
3030
| `docs/GENERATOR_CONTRACT.md` | Generator file specification | `https://lufftw.github.io/neetcode/GENERATOR_CONTRACT/` |
3131
| `docs/ARCHITECTURE_MIGRATION.md` | Architecture migration guide | `https://lufftw.github.io/neetcode/ARCHITECTURE_MIGRATION/` |
32-
| `docs/TOOLS.md` | Tools reference documentation | `https://lufftw.github.io/neetcode/TOOLS/` |
3332
| `docs/GITHUB_PAGES_SETUP.md` | GitHub Pages deployment guide | `https://lufftw.github.io/neetcode/GITHUB_PAGES_SETUP/` |
3433

3534
### 📝 Special Notes
3635

3736
- **README.md** and **README_zh-TW.md**: These files do **NOT** appear as separate pages on the website. Instead, they are included in `docs/index.md` and `docs/index_zh-TW.md` via the `include-markdown` plugin.
3837
- **docs/patterns/**: ✅ Now configured in `nav` and available on the website.
3938
- **docs/GITHUB_PAGES_SETUP.md**: ✅ Now configured in `nav` and available on the website.
40-
- **Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, `ARCHITECTURE_MIGRATION.md`, and `TOOLS.md` are now configured in `nav`.
39+
- **Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, and `ARCHITECTURE_MIGRATION.md` are now configured in `nav`.
40+
- **Tools docs**: Developer tools documentation is in [`tools/README.md`](https://github.com/lufftw/neetcode/blob/main/tools/README.md) (not on website, GitHub only).
4141

4242
---
4343

@@ -60,7 +60,7 @@ The following directories and files **do NOT** appear in the MkDocs website and
6060
| Directory/File | Description | GitHub Link Format |
6161
|:---------------|:------------|:-------------------|
6262
| `tools/*.py` | Tool scripts (code only) | `https://github.com/lufftw/neetcode/blob/main/tools/...` |
63-
| `tools/README.md` | Quick start guide | References [docs/TOOLS.md](https://lufftw.github.io/neetcode/TOOLS/) |
63+
| `tools/README.md` | Comprehensive tools reference | `https://github.com/lufftw/neetcode/blob/main/tools/README.md` |
6464
| `ontology/` | Algorithm ontology data (TOML) | `https://github.com/lufftw/neetcode/blob/main/ontology/...` |
6565
| `meta/` | Problem and pattern metadata | `https://github.com/lufftw/neetcode/blob/main/meta/...` |
6666
| `roadmaps/` | Learning path definitions | `https://github.com/lufftw/neetcode/blob/main/roadmaps/...` |
@@ -81,7 +81,6 @@ The following directories and files **do NOT** appear in the MkDocs website and
8181
- `docs/SOLUTION_CONTRACT.md` - Solution file specification
8282
- `docs/GENERATOR_CONTRACT.md` - Generator file specification
8383
- `docs/ARCHITECTURE_MIGRATION.md` - Architecture migration guide
84-
- `docs/TOOLS.md` - Tools reference documentation
8584

8685
See [Content Included in Website](#content-included-in-website) section above.
8786

@@ -188,7 +187,8 @@ A: ✅ Yes! The "📚 Reference" section is now configured in `nav` and includes
188187
- Solution Contract at `https://lufftw.github.io/neetcode/SOLUTION_CONTRACT/`
189188
- Generator Contract at `https://lufftw.github.io/neetcode/GENERATOR_CONTRACT/`
190189
- Architecture Migration at `https://lufftw.github.io/neetcode/ARCHITECTURE_MIGRATION/`
191-
- Tools documentation at `https://lufftw.github.io/neetcode/TOOLS/`
190+
191+
**Note**: Tools documentation is in [`tools/README.md`](https://github.com/lufftw/neetcode/blob/main/tools/README.md) (GitHub only, not on website).
192192

193193
### Q: Do links in README.md work in both GitHub and the website?
194194

@@ -219,7 +219,8 @@ If you need to access these documents, use the GitHub absolute URLs provided in
219219

220220
- **2025-01-XX**: Initial version
221221
- **2025-01-XX**: Updated - Added `docs/patterns/` and `docs/GITHUB_PAGES_SETUP.md` to website navigation
222-
- **2025-12-12**: Added "📚 Reference" section to nav with Solution Contract, Generator Contract, Architecture Migration, and Tools documentation
222+
- **2025-12-12**: Added "📚 Reference" section to nav with Solution Contract, Generator Contract, Architecture Migration
223+
- **2025-12-12**: Moved Tools documentation from `docs/TOOLS.md` to `tools/README.md` (developer docs belong with code)
223224
- Check `mkdocs.yml` `nav` configuration for the latest list
224225

225226
---

docs/TOOLS.md

Lines changed: 0 additions & 344 deletions
This file was deleted.

0 commit comments

Comments
 (0)