langchain-ai/docs

해결하는 문제

대규모 다중 프로젝트 생태계를 위한 문서를 작성하고 유지하는 것은 복잡합니다. 이 저장소는 소스 파일을 LangChain, LangGraph, LangSmith 및 관련 도구를 위한 정교한 문서 웹사이트(docs.langchain.com)로 변환하는 단일 자동화 파이프라인을 제공합니다. 또한 기여자에게 문서를 로컬에서 미리 보고, 빌드하고, 확인할 수 있는 명령 세트를 제공하여 게시 전에 오류를 잡을 수 있도록 합니다.

작동 방식

콘텐츠는 src/ 폴더 안에 Markdown 파일(.md 및 .mdx)로 존재하며, 이곳이 유일하게 편집해야 하는 곳입니다. 빌드 스크립트가 해당 파일을 전처리하고 배포 가능한 버전을 build/ 폴더에 출력합니다. 이 폴더가 Mintlify(호스팅 플랫폼)가 실제로 제공하는 곳입니다. 저장소에는 헬퍼 스크립트, 패키지 메타데이터, 탐색 및 설정을 제어하는 구성 파일(docs.json)도 포함되어 있습니다.

일상적인 작업에서는 Make 명령을 사용합니다: make install은 종속성을 설정하고, make dev는 라이브 리로드가 있는 로컬 서버를 시작하며, make build는 정적 파일을 생성하고, make test는 테스트 스위트를 실행합니다. 또한 docs 명령줄 도구가 있어 이전 형식의 Markdown이나 Jupyter 노트북을 Mintlify 친화적 형식(MkDocs 또는 Docusaurus 프로젝트에서 변환 포함)으로 변환하고, 교차 링크를 업데이트하면서 파일을 이동할 수 있습니다. 품질을 높게 유지하기 위해 저장소에는 두 개의 린터가 포함되어 있습니다: codespell은 산문의 철자 오류를 잡고, vale는 규칙 파일에 대해 스타일을 확인합니다. README는 또한 잘못된 디렉토리에서 Mintlify를 실행하여 발생하는 끊어진 링크와 같은 일반적인 Mintlify 문제를 해결하는 방법을 설명합니다.

대상 독자

LangChain 문서 기여자—docs.langchain.com에서 페이지를 작성, 편집 또는 수정하려는 모든 사람. 또한 빌드 프로세스를 관리하고, 레거시 문서를 마이그레이션하거나, 링크와 스타일의 일관성을 유지해야 하는 관리자에게도 유용합니다. README는 명령줄과 Git에 익숙하다고 가정하지만 모든 단계를 명확하게 설명합니다.

하이라이트

• 단일 진실 소스: src/를 편집하고 명령을 실행하면 Mintlify가 build/에서 배포합니다.
• 핫 리로드로 로컬 미리 보기(make dev).
• make broken-links-with-anchors를 통한 자동 링크 확인(앵커 포함).
• 기존 문서를 MkDocs 또는 Docusaurus에서 Mintlify 형식으로 변환하는 마이그레이션 도구.
• 철자(codespell) 및 스타일(vale) 린팅으로 산문 일관성 유지.
• .venv 파싱 오류와 같은 일반적인 Mintlify 함정에 대한 명확한 문제 해결 섹션.