[PR #342] [MERGED] oss: LINTING; add markdownlint to Makefile and run on oss/ #654

Closed
opened 2026-02-17 17:20:51 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/342
Author: @mdrxy
Created: 9/2/2025
Status: Merged
Merged: 9/3/2025
Merged by: @mdrxy

Base: mainHead: mdrxy/lint-md-mdx


📝 Commits (10+)

📊 Changes

1059 files changed (+8046 additions, -16203 deletions)

View changed files

.markdownlint.json (+8 -0)
📝 .vscode/settings.json (+18 -18)
📝 IDE_SETUP.md (+22 -5)
📝 Makefile (+28 -9)
📝 README.md (+28 -19)
lint-md.sh (+17 -0)
📝 pyproject.toml (+3 -3)
📝 src/oss/javascript/integrations/chat/anthropic.md (+24 -19)
📝 src/oss/javascript/integrations/chat/arcjet.md (+4 -4)
📝 src/oss/javascript/integrations/chat/azure.md (+12 -9)
📝 src/oss/javascript/integrations/chat/bedrock.md (+12 -4)
📝 src/oss/javascript/integrations/chat/bedrock_converse.md (+9 -4)
📝 src/oss/javascript/integrations/chat/cerebras.md (+10 -5)
📝 src/oss/javascript/integrations/chat/cloudflare_workersai.md (+6 -11)
📝 src/oss/javascript/integrations/chat/cohere.md (+15 -8)
📝 src/oss/javascript/integrations/chat/fireworks.md (+9 -4)
📝 src/oss/javascript/integrations/chat/google_generativeai.md (+23 -12)
📝 src/oss/javascript/integrations/chat/google_vertex_ai.md (+12 -11)
📝 src/oss/javascript/integrations/chat/groq.md (+11 -5)
📝 src/oss/javascript/integrations/chat/ibm.md (+12 -8)

...and 80 more files

📄 Description

Big fella - no content changes, just (mostly) automatic linting via lint-md.sh

  • Ran markdownlint in all oss/ files
    • Also added plugin to IDE_SETUP.md
    • Ensure all integration files use inline links instead of the html-link syntax (<https://example.com -> []())
  • Added markdown linting to Makefile
  • Bump ruff and mypy & lock
  • Manually went through all langchain-* files
    • Ensured no hard line breaks
    • Indent Mintlify component content
    • Note: had to resolve a gnarly merge conflict in langchain-models, may want to pay extra attention

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/342 **Author:** [@mdrxy](https://github.com/mdrxy) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/3/2025 **Merged by:** [@mdrxy](https://github.com/mdrxy) **Base:** `main` ← **Head:** `mdrxy/lint-md-mdx` --- ### 📝 Commits (10+) - [`85a4d30`](https://github.com/langchain-ai/docs/commit/85a4d30da7831b164231cab8d5cad79ef11aaad6) add script - [`983a9e3`](https://github.com/langchain-ai/docs/commit/983a9e3984fffd9200a48d2f53d8d53e2187e982) add markdownlint to makefile and update settings,json - [`d93459e`](https://github.com/langchain-ai/docs/commit/d93459e65264a44fc62eb85d6c6f89186031c680) bump ruff, mypy - [`054b20c`](https://github.com/langchain-ai/docs/commit/054b20c8d6411d77606c0f72ad2bf7e236a81df3) rename script - [`a05a81d`](https://github.com/langchain-ai/docs/commit/a05a81dc95ca6e1a1427f1a8c7bd23795aadb42a) lint non-src files - [`cdc47e3`](https://github.com/langchain-ai/docs/commit/cdc47e3b9af5ba7323ba278b45ea2808943169ff) lint entire src - [`3933407`](https://github.com/langchain-ai/docs/commit/3933407e0f844f036afaea782d03f7c8aecf5193) add back setting - [`d77deaa`](https://github.com/langchain-ai/docs/commit/d77deaa49044c2cd3e21a7d75739bd632ae7a574) add to IDE_SETUP.md - [`88d1dd8`](https://github.com/langchain-ai/docs/commit/88d1dd869060fd4885508ba07953c62fb3aa21ce) Merge branch 'main' into mdrxy/lint-md-mdx - [`a709aad`](https://github.com/langchain-ai/docs/commit/a709aad637cff610647b7544383d8f990d77322e) oss: correct langchain docs to comply with rules (#343) ### 📊 Changes **1059 files changed** (+8046 additions, -16203 deletions) <details> <summary>View changed files</summary> ➕ `.markdownlint.json` (+8 -0) 📝 `.vscode/settings.json` (+18 -18) 📝 `IDE_SETUP.md` (+22 -5) 📝 `Makefile` (+28 -9) 📝 `README.md` (+28 -19) ➕ `lint-md.sh` (+17 -0) 📝 `pyproject.toml` (+3 -3) 📝 `src/oss/javascript/integrations/chat/anthropic.md` (+24 -19) 📝 `src/oss/javascript/integrations/chat/arcjet.md` (+4 -4) 📝 `src/oss/javascript/integrations/chat/azure.md` (+12 -9) 📝 `src/oss/javascript/integrations/chat/bedrock.md` (+12 -4) 📝 `src/oss/javascript/integrations/chat/bedrock_converse.md` (+9 -4) 📝 `src/oss/javascript/integrations/chat/cerebras.md` (+10 -5) 📝 `src/oss/javascript/integrations/chat/cloudflare_workersai.md` (+6 -11) 📝 `src/oss/javascript/integrations/chat/cohere.md` (+15 -8) 📝 `src/oss/javascript/integrations/chat/fireworks.md` (+9 -4) 📝 `src/oss/javascript/integrations/chat/google_generativeai.md` (+23 -12) 📝 `src/oss/javascript/integrations/chat/google_vertex_ai.md` (+12 -11) 📝 `src/oss/javascript/integrations/chat/groq.md` (+11 -5) 📝 `src/oss/javascript/integrations/chat/ibm.md` (+12 -8) _...and 80 more files_ </details> ### 📄 Description Big fella - no content changes, just (mostly) automatic linting via `lint-md.sh` - Ran `markdownlint` in all `oss/` files - Also added plugin to `IDE_SETUP.md` - Ensure all integration files use inline links instead of the html-link syntax (`<https://example.com` -> `[]()`) - Added markdown linting to `Makefile` - Bump `ruff` and `mypy` & lock - Manually went through all `langchain-*` files - Ensured no hard line breaks - Indent Mintlify component content - Note: had to resolve a gnarly merge conflict in `langchain-models`, may want to pay extra attention --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-17 17:20:51 -05:00
yindo closed this issue 2026-02-17 17:20:51 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#654