Skip to content

Commit 45c2733

Browse files
committed
docs: Add local documentation build options to README
- Add "Build Documentation Locally" section in For Contributors - Recommend BUILD_DOCS_MANUAL.md as the simple method - Mark ACT_LOCAL_GITHUB_ACTIONS.md as optional advanced option - Reorganize Documentation section with clear categorization - Emphasize that documentation building is completely optional
1 parent 6a84644 commit 45c2733

File tree

6 files changed

+1570
-1727
lines changed

6 files changed

+1570
-1727
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,13 +1028,48 @@ python tools/generate_mindmaps.py --html
10281028

10291029
Configuration: `tools/generate_mindmaps.toml`
10301030

1031+
### Build Documentation Locally
1032+
1033+
> ⚠️ **Optional Feature:** Building documentation locally is **completely optional**. Core LeetCode practice functionality works without any documentation build setup.
1034+
1035+
**Recommended Method (Simple):**
1036+
1037+
The easiest way to build documentation locally is using the manual scripts:
1038+
1039+
```bash
1040+
# Windows
1041+
scripts\build_docs.bat
1042+
1043+
# Linux/macOS
1044+
./scripts/build_docs.sh
1045+
1046+
# Build and preview locally
1047+
scripts\build_docs.bat --serve # Windows
1048+
./scripts/build_docs.sh --serve # Linux/macOS
1049+
```
1050+
1051+
📖 **See [Building Documentation Locally (Manual Method)](docs/BUILD_DOCS_MANUAL.md)** for complete guide.
1052+
1053+
**Advanced Option (Optional):**
1054+
1055+
If you want to test the exact GitHub Actions workflow locally, you can use `act`:
1056+
1057+
📖 **See [Running GitHub Actions Locally with Act](docs/ACT_LOCAL_GITHUB_ACTIONS.md)***Note: Requires Docker and act tool. Only needed if you want to test CI/CD workflows.*
1058+
10311059
### Documentation
10321060

1061+
**Core Documentation:**
10331062
- [`.dev/README.md`](https://github.com/lufftw/neetcode/blob/main/.dev/README.md) — Maintainer guide
10341063
- [`.dev/TESTING.md`](https://github.com/lufftw/neetcode/blob/main/.dev/TESTING.md) — Testing documentation
10351064
- [`docs/SOLUTION_CONTRACT.md`](docs/SOLUTION_CONTRACT.md) — Solution file specification (SOLUTIONS dict, JUDGE_FUNC)
10361065
- [`docs/GENERATOR_CONTRACT.md`](docs/GENERATOR_CONTRACT.md) — Generator file specification (generate(), edge cases, complexity)
10371066
- [`docs/ARCHITECTURE_MIGRATION.md`](docs/ARCHITECTURE_MIGRATION.md) — Polymorphic architecture migration guide
1067+
1068+
**Local Documentation Build (Optional):**
1069+
- [`docs/BUILD_DOCS_MANUAL.md`](docs/BUILD_DOCS_MANUAL.md) — ⭐ **Recommended:** Simple manual build method
1070+
- [`docs/ACT_LOCAL_GITHUB_ACTIONS.md`](docs/ACT_LOCAL_GITHUB_ACTIONS.md) — Advanced: Test CI/CD workflows locally with act (requires Docker)
1071+
1072+
**Deployment:**
10381073
- [`docs/GITHUB_PAGES_SETUP.md`](docs/GITHUB_PAGES_SETUP.md) — Deployment guide
10391074

10401075
---

0 commit comments

Comments
 (0)