docs/scripts at e0d7bb27e954a23919f85687df0ae9d65ff8c4fe - docs

mirror of https://github.com/langchain-ai/docs.git synced 2026-07-21 03:45:28 -04:00

Files

T

Mason Daugherty e0d7bb27e9 feat: add CI check for unresolved @[ref] cross-references (#3051 )

## Description
Adds a check that validates all `@[ref]` cross-references in source
MDX/MD files resolve against entries in `link_map.py`. Previously,
unresolved references silently passed through the build pipeline and
appeared as raw `@[ClassName]` text in the published docs. Available via
`make check-cross-refs`.

Note: I couldn't modify `.github/workflows/_check-links.yml` due to
workflow permissions. To integrate into CI, add this step to
`_check-links.yml` after "Install Python dependencies":
```yaml
- name: Check for unresolved cross-references
  run: make check-cross-refs
```

## Test Plan
- [ ] `make check-cross-refs` reports unresolved references with file,
line number, and scope
- [ ] 12 unit tests covering: valid refs, unresolved refs, scope fences,
code block skipping, escaped refs, titled refs, backtick refs, and
code-samples exclusion

---------

Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>

2026-03-13 17:35:55 -04:00

__init__.py

feat(ci): validate imports from langchain (#1445 )

2025-11-22 17:28:42 -05:00

check_cross_refs.py

feat: add CI check for unresolved @[ref] cross-references (#3051 )

2026-03-13 17:35:55 -04:00

check_import_mappings.py

cleanup build logs (#3118 )

2026-03-13 17:10:12 -04:00

check_pr_imports.py

cleanup build logs (#3118 )