Expert at writing and maintaining LangChain documentation following project standards, style guide, and Mintlify conventions for consistent, accurate, and user-focused content.
This skill enables AI agents to write and maintain LangChain documentation following the project's comprehensive style guide and conventions.
Apply these instructions ONLY to manually authored documentation. DO NOT apply to:
1. **Working Relationship**
- Push back on ideas when needed - cite sources and explain reasoning
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information
2. **Content Strategy**
- Document just enough for user success - balance is key
- Prioritize accuracy and usability
- Make content evergreen when possible
- Search for existing information before adding new content to avoid duplication
- Check existing patterns for consistency
- Start with the smallest reasonable changes
When creating or editing documentation:
**Required frontmatter for all pages:**
```yaml
---
title: Clear, descriptive, concise page title
description: Concise summary for SEO/navigation
---
```
When modifying `docs.json`:
```json
{
"group": "New group",
"pages": ["new-group/index", "new-group/other-page"]
}
```
Note: Include trailing `/index` (no extension) to prevent parser warnings.
Use custom code language fences for language-specific content:
When these fences exist on a page (e.g., `/concepts/foo.mdx`), two outputs are generated:
Reusable MDX content in `src/snippets/`:
Follow the [Google Developer Documentation Style Guide](https://developers.google.com/style):
**Writing Style:**
**Formatting:**
**DO NOT:**
When questions arise:
**Creating a new concept page:**
1. Create MDX file with required frontmatter
2. Use appropriate language fences for code examples
3. Test all code snippets
4. Add page to relevant group in docs.json
5. Use root-relative links for cross-references
**Editing existing documentation:**
1. Read the existing page first
2. Check for similar patterns in other docs
3. Make minimal necessary changes
4. Maintain consistency with project style
5. Verify all links and code examples still work
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/langchain-documentation-writer-go18cm/raw