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
fix(mkdocs): Correct pattern navigation paths to subdirectories
- Fix pattern navigation to point to actual files in subdirectories
- Change from non-existent .md files to nested structure:
- patterns/sliding_window/intuition.md
- patterns/sliding_window/templates.md
- patterns/two_pointers/intuition.md
- patterns/two_pointers/templates.md
- patterns/backtracking_exploration/intuition.md
- patterns/backtracking_exploration/templates.md
- Update MKDOCS_CONTENT_GUIDE.md to reflect correct path structure
-**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.
39
44
-**docs/patterns/**: ✅ Now configured in `nav` and available on the website.
40
45
-**docs/GITHUB_PAGES_SETUP.md**: ✅ Now configured in `nav` and available on the website.
41
-
-**Local build guides**: ✅ `BUILD_DOCS_MANUAL.md` (recommended) and `ACT_LOCAL_GITHUB_ACTIONS.md` (optional) are now configured in `nav`.
42
-
-**Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, and `ARCHITECTURE_MIGRATION.md` are now configured in `nav`.
46
+
-**Local build guides**: ✅ `BUILD_DOCS_MANUAL.md` (recommended), `LOCAL_DOCS_BUILD.md`, and `ACT_LOCAL_GITHUB_ACTIONS.md` (optional) are now configured in `nav`.
47
+
-**Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, `ARCHITECTURE_MIGRATION.md`, and `ONTOLOGY_DESIGN.md` are now configured in `nav`.
48
+
-**Guides**: ✅ `MKDOCS_CONTENT_GUIDE.md` is now configured in `nav`.
49
+
-**Patterns**: ✅ `backtracking_exploration` pattern is now available in `nav` alongside `sliding_window` and `two_pointers`.
43
50
-**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).
44
51
45
52
---
@@ -72,22 +79,11 @@ The following directories and files **do NOT** appear in the MkDocs website and
|`docs/MKDOCS_CONTENT_GUIDE.md`| This file |`https://github.com/lufftw/neetcode/blob/main/docs/MKDOCS_CONTENT_GUIDE.md`|
82
+
**Note**: All major documentation files are now configured in `nav` and available on the website. See [Content Included in Website](#content-included-in-website) section above for the complete list.
79
83
80
-
**Note**: The following docs are now configured in `nav` and available on the website:
Each pattern includes both Intuition and Templates documentation as separate pages in the navigation.
218
+
200
219
### Q: Do links in README.md work in both GitHub and the website?
201
220
202
221
A: It depends on the link type:
@@ -229,6 +248,9 @@ If you need to access these documents, use the GitHub absolute URLs provided in
229
248
-**2025-12-12**: Added "📚 Reference" section to nav with Solution Contract, Generator Contract, Architecture Migration
230
249
-**2025-12-12**: Moved Tools documentation from `docs/TOOLS.md` to `tools/README.md` (developer docs belong with code)
231
250
-**2025-01-XX**: Added local documentation build guides - `BUILD_DOCS_MANUAL.md` (recommended) and `ACT_LOCAL_GITHUB_ACTIONS.md` (optional) to Guides section
251
+
-**2025-12-XX**: Added `ONTOLOGY_DESIGN.md` to Reference section
252
+
-**2025-12-XX**: Added `MKDOCS_CONTENT_GUIDE.md` and `LOCAL_DOCS_BUILD.md` to Guides section
253
+
-**2025-12-XX**: Added `backtracking_exploration` pattern to Patterns section
232
254
- Check `mkdocs.yml``nav` configuration for the latest list
0 commit comments