You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
-**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.
38
37
-**docs/patterns/**: ✅ Now configured in `nav` and available on the website.
39
38
-**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).
41
41
42
42
---
43
43
@@ -60,7 +60,7 @@ The following directories and files **do NOT** appear in the MkDocs website and
60
60
| Directory/File | Description | GitHub Link Format |
0 commit comments