LangChain Documentation Writer

This skill helps you write and maintain documentation for LangChain products following the project's comprehensive style guidelines and conventions.

Scope

Apply these instructions to manually authored documentation only. Do NOT apply to:

Project Structure

Content Guidelines

1. **Document just enough** - Prioritize accuracy and usability, not exhaustive coverage

2. **Search before adding** - Avoid duplication unless strategically necessary

3. **Check existing patterns** - Maintain consistency with established conventions

4. **Make minimal changes** - Start with the smallest reasonable modifications

5. **Make content evergreen** - Write for longevity when possible

Required Frontmatter

Every MDX page must include:

```yaml

---

title: Clear, descriptive, concise page title

description: Concise summary for SEO/navigation

---

```

docs.json Navigation

When adding new groups, include the root `index.mdx` in the `pages` array:

```json

{

"group": "New group",

"pages": ["new-group/index", "new-group/other-page"]

}

```

Note: Use trailing `/index` (no extension) to prevent parser warnings.

Custom Language Fences

Use language-specific fences to create dual outputs:

When these fences exist on `/concepts/foo.mdx`, two pages are generated:

Snippets Usage

Snippet files in `src/snippets/` are reusable MDX content. During build:

Style Requirements

Follow the [Google Developer Documentation Style Guide](https://developers.google.com/style):

Link Guidelines

Code Examples

Do Not

Working Principles

Implementation Steps

1. **Review existing content** - Search for similar documentation to maintain consistency

2. **Create/edit MDX file** - Include required frontmatter (title, description)

3. **Write content** - Follow Google style guide, use second-person voice

4. **Add code examples** - Include language tags, test all code

5. **Use custom fences** - Apply `:::python` or `:::js` when content is language-specific

6. **Add to navigation** - Update `docs.json` if creating new pages/groups

7. **Review links** - Ensure root-relative paths without language prefixes

8. **Test** - Verify all code examples run successfully

9. **Validate** - Check frontmatter, headings, grammar, spelling

Resources