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: Add local build guides to MkDocs navigation and content guide
- Add BUILD_DOCS_MANUAL.md and ACT_LOCAL_GITHUB_ACTIONS.md to mkdocs.yml nav
- Update MKDOCS_CONTENT_GUIDE.md to reflect new documentation pages
- Add linking examples and update log entries
- Mark BUILD_DOCS_MANUAL.md as recommended method
|`docs/BUILD_DOCS_MANUAL.md`| Local documentation build (manual method) |`https://lufftw.github.io/neetcode/BUILD_DOCS_MANUAL/`|
34
+
|`docs/ACT_LOCAL_GITHUB_ACTIONS.md`| Run GitHub Actions locally with act |`https://lufftw.github.io/neetcode/ACT_LOCAL_GITHUB_ACTIONS/`|
33
35
34
36
### 📝 Special Notes
35
37
36
38
-**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.
37
39
-**docs/patterns/**: ✅ Now configured in `nav` and available on the website.
38
40
-**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`.
39
42
-**Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, and `ARCHITECTURE_MIGRATION.md` are now configured in `nav`.
40
43
-**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
44
@@ -78,6 +81,8 @@ The following directories and files **do NOT** appear in the MkDocs website and
@@ -221,6 +228,7 @@ If you need to access these documents, use the GitHub absolute URLs provided in
221
228
-**2025-01-XX**: Updated - Added `docs/patterns/` and `docs/GITHUB_PAGES_SETUP.md` to website navigation
222
229
-**2025-12-12**: Added "📚 Reference" section to nav with Solution Contract, Generator Contract, Architecture Migration
223
230
-**2025-12-12**: Moved Tools documentation from `docs/TOOLS.md` to `tools/README.md` (developer docs belong with code)
231
+
-**2025-01-XX**: Added local documentation build guides - `BUILD_DOCS_MANUAL.md` (recommended) and `ACT_LOCAL_GITHUB_ACTIONS.md` (optional) to Guides section
224
232
- Check `mkdocs.yml``nav` configuration for the latest list
0 commit comments