Skip to content

Commit 805a3df

Browse files
committed
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
1 parent 45c2733 commit 805a3df

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/MKDOCS_CONTENT_GUIDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,15 @@ Based on the `nav` configuration in `mkdocs.yml`, the following content is inclu
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/` |
3232
| `docs/GITHUB_PAGES_SETUP.md` | GitHub Pages deployment guide | `https://lufftw.github.io/neetcode/GITHUB_PAGES_SETUP/` |
33+
| `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/` |
3335

3436
### 📝 Special Notes
3537

3638
- **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.
3739
- **docs/patterns/**: ✅ Now configured in `nav` and available on the website.
3840
- **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`.
3942
- **Reference docs**: ✅ `SOLUTION_CONTRACT.md`, `GENERATOR_CONTRACT.md`, and `ARCHITECTURE_MIGRATION.md` are now configured in `nav`.
4043
- **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).
4144

@@ -78,6 +81,8 @@ The following directories and files **do NOT** appear in the MkDocs website and
7881

7982
- `docs/patterns/` - Pattern documentation
8083
- `docs/GITHUB_PAGES_SETUP.md` - GitHub Pages setup guide
84+
- `docs/BUILD_DOCS_MANUAL.md` - Local documentation build (manual method, recommended)
85+
- `docs/ACT_LOCAL_GITHUB_ACTIONS.md` - Run GitHub Actions locally with act (optional, advanced)
8186
- `docs/SOLUTION_CONTRACT.md` - Solution file specification
8287
- `docs/GENERATOR_CONTRACT.md` - Generator file specification
8388
- `docs/ARCHITECTURE_MIGRATION.md` - Architecture migration guide
@@ -136,6 +141,8 @@ When linking to content in README.md, follow these strategies:
136141
<!-- Document in nav - can use relative paths -->
137142
- [📐 Patterns](docs/patterns/) — Pattern documentation
138143
- [GitHub Pages Setup](docs/GITHUB_PAGES_SETUP.md) — Deployment guide
144+
- [Build Documentation Locally](docs/BUILD_DOCS_MANUAL.md) — Manual build method (recommended)
145+
- [Run GitHub Actions Locally](docs/ACT_LOCAL_GITHUB_ACTIONS.md) — Act method (optional, advanced)
139146

140147
<!-- Document NOT in nav - use GitHub URLs -->
141148
- [`docs/ONTOLOGY_DESIGN.md`](https://github.com/lufftw/neetcode/blob/main/docs/ONTOLOGY_DESIGN.md) — Ontology design documentation
@@ -221,6 +228,7 @@ If you need to access these documents, use the GitHub absolute URLs provided in
221228
- **2025-01-XX**: Updated - Added `docs/patterns/` and `docs/GITHUB_PAGES_SETUP.md` to website navigation
222229
- **2025-12-12**: Added "📚 Reference" section to nav with Solution Contract, Generator Contract, Architecture Migration
223230
- **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
224232
- Check `mkdocs.yml` `nav` configuration for the latest list
225233

226234
---

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ nav:
124124
- Architecture Migration: ARCHITECTURE_MIGRATION.md
125125
- 🔧 Guides:
126126
- GitHub Pages Setup: GITHUB_PAGES_SETUP.md
127+
- Build Documentation Locally (Manual): BUILD_DOCS_MANUAL.md
128+
- Run GitHub Actions Locally (Act): ACT_LOCAL_GITHUB_ACTIONS.md
127129

128130
# Extra
129131
extra:

0 commit comments

Comments
 (0)