Skip to content

Commit cfa3d48

Browse files
fix(ci): resolve markdownlint and internal link check failures
Wrap the local preview URL in CONTRIBUTING.md, generate docs/CONTRIBUTING.md before link checks, and ignore generated docs from markdownlint. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 77aa29a commit cfa3d48

4 files changed

Lines changed: 14 additions & 1 deletion

File tree

‎.markdownlint-cli2.jsonc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"config": ".markdownlint.json",
3+
"ignores": [
4+
"docs/CONTRIBUTING.md",
5+
"research/**"
6+
]
7+
}

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ python scripts/prepare-mkdocs.py
5353
mkdocs serve
5454
```
5555

56-
Open http://127.0.0.1:8000/Awesome-Ads/ in your browser.
56+
Open [http://127.0.0.1:8000/Awesome-Ads/](http://127.0.0.1:8000/Awesome-Ads/) in your browser.
5757

5858
## Standards
5959

‎scripts/AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Maintenance utilities for repository quality checks.
1515
- Resolves relative link targets from the containing file's directory.
1616
- Skips `http://`, `https://`, `mailto:`, `#`, and `ftp://` URLs.
1717
- Exit code `0` on success, `1` when broken links are found.
18+
- Runs `prepare-mkdocs.py` first so generated files such as `docs/CONTRIBUTING.md` exist before link resolution.
1819

1920
Run from the repository root:
2021

‎scripts/check-internal-links.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
from __future__ import annotations
55

66
import re
7+
import subprocess
78
import sys
89
from pathlib import Path
910

@@ -39,6 +40,10 @@ def collect_errors(root: Path) -> list[str]:
3940

4041
def main() -> int:
4142
root = Path(__file__).resolve().parent.parent
43+
prepare_script = root / "scripts" / "prepare-mkdocs.py"
44+
if prepare_script.exists():
45+
subprocess.run([sys.executable, str(prepare_script)], check=True)
46+
4247
errors = collect_errors(root)
4348

4449
if errors:

0 commit comments

Comments
 (0)