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
build: exclude generated markdown from git, update CI/CD docs
- Update .gitignore to exclude docs/mindmaps/*.md (rule-based)
- Update CI/CD to generate both Markdown and HTML mindmaps
- Remove 9 generated markdown files from git tracking
- Update docs/GITHUB_PAGES_SETUP.md with:
- New workflow configuration
- Version control summary table
- Updated directory structure
- Complete workflow diagram
Rule-based files are now fully generated by CI/CD.
Only AI-generated and manual files remain in version control.
@@ -414,17 +438,24 @@ The README.md already includes links to interactive mind maps:
414
438
↓
415
439
3. GitHub Actions automatically triggers
416
440
↓
417
-
4. Generate rule-based mind maps (Markdown + HTML)
418
-
python tools/generate_mindmaps.py --html
441
+
4. Generate rule-based mind maps
442
+
python tools/generate_mindmaps.py # Markdown
443
+
python tools/generate_mindmaps.py --html # HTML
419
444
↓
420
445
5. Build MkDocs site
421
-
python -m mkdocs build
446
+
mkdocs build
422
447
↓
423
-
6. Deploy to GitHub Pages
448
+
6. Copy HTML files to site/
449
+
cp -r docs/pages/mindmaps site/pages/mindmaps
424
450
↓
425
-
7. Visit https://yourusername.github.io/neetcode/
451
+
7. Deploy to GitHub Pages
452
+
↓
453
+
8. Visit https://lufftw.github.io/neetcode/
426
454
```
427
455
456
+
> **Note**: Rule-based Markdown files (`docs/mindmaps/*.md`) are NOT tracked in Git.
457
+
> They are generated fresh by CI/CD on every deployment.
458
+
428
459
### AI-Powered Mind Maps (Manual Process)
429
460
430
461
```
@@ -530,7 +561,20 @@ Both are gitignored and regenerated on build/deploy.
530
561
531
562
## 📝 Notes
532
563
533
-
-**Local Development**: Always test locally with `python -m mkdocs build` and `python -m mkdocs serve` before pushing
564
+
-**Local Development**: Always test locally with `mkdocs build` and `mkdocs serve` before pushing
534
565
-**Build Output**: The `site/` directory contains the complete MkDocs site and is gitignored
535
-
-**Mind Maps**: HTML mind maps are generated to `docs/pages/mindmaps/` and are also gitignored
566
+
-**Generated Files**: Both Markdown (`docs/mindmaps/*.md`) and HTML (`docs/pages/mindmaps/*.html`) mind maps are gitignored (except AI and manual files)
536
567
-**Auto Deployment**: GitHub Actions handles generation, building, and deployment automatically
568
+
-**AI Mind Maps**: Must be generated manually and committed (require API key, not in CI/CD)
569
+
570
+
### Version Control Summary
571
+
572
+
| File | Tracked | Reason |
573
+
|------|---------|--------|
574
+
|`docs/mindmaps/index.md`| ✅ | Manual index page |
0 commit comments