Skip to content

Commit daaa3dd

Browse files
committed
fix: repair all 37 dead links and mkdocs strict-build config error
Check Links: fixed off-by-one relative path depth bugs (missing a ../ level) across 8 nested docs/ and root files, corrected renamed notebook filenames in 01_Data_Scientist and 03_AI_Engineer READMEs, replaced dead external resources (Chip Huyen post removed, GitHub repos 404, DrivenData/Azure ML paths reorganized, wrong arXiv ID) with live equivalents, de-linked a hackathon TOC pointing at sections that were never written, and added mlwave.com (bot-blocking) plus the idea_template.md arXiv placeholder to mlc_config.json ignorePatterns. Deploy Documentation: mkdocs 1.6.1 now rejects docs_dir being the same directory as mkdocs.yml itself. Moved the config into .mkdocs/ with docs_dir: '..' so it resolves to the repo root as before, and moved site_dir outside docs_dir entirely (../../site) to satisfy the site_dir-nested-in-docs_dir check too. Verified `mkdocs build --strict` now exits 0 and markdown-link-check reports 0 dead links across all 130 files.
1 parent c96e04a commit daaa3dd

22 files changed

Lines changed: 61 additions & 57 deletions

File tree

.github/mlc_config.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
},
99
{
1010
"pattern": "^https://teamblind.com"
11+
},
12+
{
13+
"pattern": "^https://mlwave.com"
14+
},
15+
{
16+
"pattern": "^https://arxiv.org/abs/XXXX"
1117
}
1218
],
1319
"timeout": "20s",

.github/workflows/deploy-docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
- main
88
paths:
99
- '**/*.md'
10-
- 'mkdocs.yml'
10+
- '.mkdocs/mkdocs.yml'
1111
workflow_dispatch:
1212

1313
permissions:
@@ -37,12 +37,12 @@ jobs:
3737
run: pip install mkdocs-material mkdocs-minify-plugin
3838

3939
- name: Build documentation
40-
run: mkdocs build --strict
40+
run: mkdocs build --strict -f .mkdocs/mkdocs.yml
4141

4242
- name: Upload Pages artifact
4343
uses: actions/upload-pages-artifact@v3
4444
with:
45-
path: site/
45+
path: ../site/
4646

4747
deploy:
4848
needs: build

mkdocs.yml renamed to .mkdocs/mkdocs.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ repo_url: https://github.com/viraj97-sl/ai-ml-ds-learning-hub
99
repo_name: viraj97-sl/ai-ml-ds-learning-hub
1010
edit_uri: edit/master/
1111

12-
docs_dir: '.'
13-
site_dir: site
12+
docs_dir: '..'
13+
site_dir: ../../site
1414

1515
theme:
1616
name: material
@@ -73,7 +73,6 @@ markdown_extensions:
7373
permalink: true
7474

7575
exclude_docs: |
76-
site/
7776
venv/
7877
.venv/
7978
*.ipynb

00_Overview/salary_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@
153153

154154
### Research Your Market Value
155155
1. Check [Levels.fyi](https://levels.fyi) for tech company data points
156-
2. Use [Glassdoor](https://glassdoor.com), [LinkedIn Salary](https://linkedin.com/salary), [Payscale](https://payscale.com)
156+
2. Use [Glassdoor](https://glassdoor.com), [LinkedIn Salary](https://linkedin.com/salary), [Payscale](https://www.payscale.com)
157157
3. Ask peers in communities (Blind, Discord servers, Reddit r/cscareerquestions)
158158
4. Talk to recruiters — they know market rates
159159
5. Get multiple offers simultaneously for the strongest leverage

01_Data_Scientist/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Before starting this track, make sure you have:
8282
|------|-------|----------|----------|
8383
| 1-2 | Python for DS refresher | [Python for DS](../04_Foundations/programming/python_for_ds.md) | [Exercises](beginner/01_python_exercises.ipynb) |
8484
| 3-4 | pandas & NumPy | [Data Manipulation Guide](beginner/02_pandas_numpy.ipynb) | Analyze Titanic dataset |
85-
| 5-6 | Statistics Foundations | [Stats Guide](../04_Foundations/statistics/) | [Stats Notebook](beginner/03_statistics.ipynb) |
86-
| 7-8 | Data Visualization | [Visualization Guide](beginner/04_visualization.ipynb) | Create 10 chart types |
85+
| 5-6 | Statistics Foundations | [Stats Guide](../04_Foundations/statistics/) | [Stats Notebook](beginner/03_statistics_fundamentals.ipynb) |
86+
| 7-8 | Data Visualization | [Visualization Guide](beginner/04_data_visualization.ipynb) | Create 10 chart types |
8787
| 9-10 | EDA Workflow | [EDA Notebook](beginner/05_eda_workflow.ipynb) | Full EDA on 2 datasets |
8888
| 11-12 | SQL for Analysis | [SQL Guide](../04_Foundations/programming/sql_basics.md) | [SQL Exercises](beginner/06_sql_exercises.ipynb) |
8989

@@ -114,7 +114,7 @@ Before starting this track, make sure you have:
114114
| 5-6 | Feature Engineering | [Feature Engineering Guide](intermediate/03_feature_engineering.ipynb) | Engineer 10 new features |
115115
| 7-8 | Model Evaluation | [Evaluation Metrics](intermediate/04_model_evaluation.ipynb) | Cross-validate 5 models |
116116
| 9-10 | Ensemble Methods | [Ensembles Guide](intermediate/05_ensemble_methods.ipynb) | XGBoost competition entry |
117-
| 11-12 | Unsupervised Learning | [Clustering & Dimensionality](intermediate/06_unsupervised.ipynb) | Customer segmentation project |
117+
| 11-12 | Unsupervised Learning | [Clustering & Dimensionality](intermediate/06_unsupervised_learning.ipynb) | Customer segmentation project |
118118
| 13-14 | ML Pipelines | [sklearn Pipelines](intermediate/07_ml_pipelines.ipynb) | Build production-ready pipeline |
119119

120120
**[→ Start Intermediate Phase](intermediate/)**
@@ -143,7 +143,7 @@ Before starting this track, make sure you have:
143143
| 1-3 | Deep Learning Intro | [Deep Learning Guide](advanced/01_deep_learning_intro.ipynb) | Train neural network from scratch |
144144
| 4-6 | NLP Fundamentals | [NLP Guide](advanced/02_nlp_fundamentals.ipynb) | Sentiment analysis project |
145145
| 7-9 | Time Series | [Time Series Guide](advanced/03_time_series.ipynb) | Sales forecasting project |
146-
| 10-12 | A/B Testing & Experimentation | [Experiment Design Guide](advanced/04_ab_testing.ipynb) | Design and analyze experiment |
146+
| 10-12 | A/B Testing & Experimentation | [Experiment Design Guide](advanced/04_ab_testing_advanced.ipynb) | Design and analyze experiment |
147147
| 13-15 | Bayesian Statistics | [Bayesian Guide](advanced/05_bayesian_statistics.ipynb) | Bayesian A/B test |
148148
| 16-18 | Model Interpretability | [XAI Guide](advanced/06_model_interpretability.ipynb) | Explain black-box model |
149149
| 19-21 | Causal Inference | [Causality Guide](advanced/07_causal_inference.ipynb) | Propensity score matching |

03_AI_Engineer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ PHASE 4: Expert (Ongoing)
116116
| 1-3 | LLM Fine-tuning (LoRA/QLoRA + Alignment) | [Fine-tuning Guide](advanced/01_llm_finetuning_alignment.ipynb) | Fine-tune Llama 3 |
117117
| 4-6 | Multi-agent systems | [Multi-agent Guide](advanced/02_multi_agent_systems.ipynb) | Research + report agent |
118118
| 7-9 | Advanced Retrieval techniques | [Advanced Retrieval](advanced/04_advanced_retrieval.ipynb) | Multi-strategy retrieval |
119-
| 10-12 | AI Ethics, Safety & Guardrails | [Ethics & Safety Guide](advanced/03_ethics_safety_guardrails.ipynb) | Implement a responsible AI toolkit (bias detection, guardrails) |
119+
| 10-12 | AI Ethics, Safety & Guardrails | [Ethics & Safety Guide](advanced/03_safety_guardrails.ipynb) | Implement a responsible AI toolkit (bias detection, guardrails) |
120120
| 13-15 | GraphRAG & Knowledge Graphs | [GraphRAG Guide](advanced/05_graphrag.ipynb) | Knowledge graph RAG |
121121
| 16-18 | Custom LLM Evaluation | [Advanced Evals](advanced/06_advanced_evals.ipynb) | Custom eval framework |
122-
| 19-21 | AI Product Case Studies | [Case Studies](advanced/07_case_studies.md) | Analyze + present |
122+
| 19-21 | AI Product Case Studies | Case Studies (find and analyze 3 public post-mortems) | Analyze + present |
123123

124124
**[→ Start Advanced Phase](advanced/)**
125125

04_Foundations/programming/python_for_ds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,4 +402,4 @@ Try these to solidify your skills:
402402

403403
---
404404

405-
*Back to: [Foundations](../README.md) | [DS Track](../../01_Data_Scientist/) | [MLE Track](../../02_ML_Engineer/)*
405+
*Back to: [DS Track](../../01_Data_Scientist/) | [MLE Track](../../02_ML_Engineer/)*

04_Foundations/statistics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,4 +347,4 @@ plt.show()
347347

348348
---
349349

350-
*Back to: [Foundations](../README.md) | [DS Track](../../01_Data_Scientist/) | [Main README](../../README.md)*
350+
*Back to: [DS Track](../../01_Data_Scientist/) | [Main README](../../README.md)*

08_Career_Guide/networking_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,4 +343,4 @@ Referrals are 4-6x more likely to convert to an offer than cold applications.
343343

344344
---
345345

346-
*Back to: [Career Guide](../README.md) | [Portfolio Guide](./portfolio_guide.md) | [Main README](../../README.md)*
346+
*Back to: [Career Guide](../README.md) | [Portfolio Guide](./portfolio_guide.md) | [Main README](../README.md)*

08_Career_Guide/resume_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,4 +358,4 @@ print(extract_keywords(jd))
358358

359359
---
360360

361-
*Back to: [Career Guide](../README.md) | [Main README](../../README.md)*
361+
*Back to: [Career Guide](../README.md) | [Main README](../README.md)*

0 commit comments

Comments
 (0)