| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 33 | 1 | 0% |
| Commands | 0 | 6 | 0 | 0% |
| Section tags | 0 | 11 | 1 | 0% |
What each file covers
Sections
0 shared · 33 only in A · 1 only in B- − Documentation Development Guidelines
- − Purpose
- − 1. Documentation Environment Setup
- − Prerequisites
- − Documentation Service
- − 2. Documentation Structure
- − Directory Layout
- − 3. Writing Documentation
- − Frontmatter
- − MDX Imports
- − Admonitions
- − Images and Assets
- − 4. Component Documentation
- − Component Page Template
- − Use the Component Name component in a flow
- − Component Name parameters
- − API Documentation
- − Endpoint
- − Request body
- − Example
- − 5. Documentation Testing
- − Build and serve
- − API examples
- − Content Review
- − Screenshots
- − 6. Style Guide
- − Writing Style
- − Formatting
- − Terminology
- − 7. Deployment
- − Local Testing
- − Production Deployment
- − Documentation Development Checklist
- + CLAUDE.md
Commands
0 shared · 6 only in A · 0 only in B- − npm install
- − npm run start
- − npm run build
- − npm run serve
- − make api_examples_local
- − make api_examples_local_syntax
Section tags
0 shared · 11 only in A · 1 only in B- − setup
- − build
- − test
- − lint-format
- − code-style
- − architecture
- − git-pr
- − api
- − ui
- − deployment
- − docs
- + agent-behaviour
Line diff
langflow-ai/langflow · .cursor/rules/docs_development.mdc
@@ −1 @@
1---
2description: "Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes."
3globs:
4 - "docs/**/*.{md,mdx}"
5 - "docs/**/*.{js,jsx,ts,tsx}"
6 - "docs/package*.json"
7 - "docs/docusaurus.config.js"
8 - "docs/sidebars.js"
9 - "docs/static/**/*"
10alwaysApply: false
11---
12
13# Documentation Development Guidelines
14
15## Purpose
16Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes.
17
18---
19
20## 1. Documentation Environment Setup
21
22### Prerequisites
23- **Node.js:** v22.12 LTS for runtime
24- **Package Manager:** npm for dependency management
25- **Documentation Framework:** Docusaurus v3
26
27### Documentation Service
28```bash
29cd docs
30npm install # Install dependencies
31npm run start # Start dev server
32```
33- Auto-reloads on documentation changes
34- Access at: http://localhost:3000/
35- Documentation source: `docs/`
36
37---
38
39## 2. Documentation Structure
40
41### Directory Layout
42```
43docs/
44├── docs/ # Main documentation content
45│ ├── agents/ # Agent and MCP guides
46│ ├── get-started/ # Getting started guides
47│ ├── tutorials/ # Langflow tutorials
48│ ├── components/ # Component documentation
49│ ├── flows/ # Guides to build, run, and test flows
50│ ├── deployment/ # Guides for deploying and hosting a Langflow server
51│ ├── develop/ # Guides for developing apps with Langflow
52│ ├── support/ # Help and release notes
53│ ├── contributing/ # Contribution guidelines
54│ ├── api-reference/ # API documentation
55│ └── _partial-*.mdx # Shared content partials (imported by other pages)
56├── src/ # Custom React components
57├── static/ # Static assets (images, etc.)
58├── sidebars.js # Sidebar configuration
59├── docusaurus.config.js # Main configuration
60└── package.json # Dependencies
61```
62
63---
64
65## 3. Writing Documentation
66
67### Frontmatter
68Every `.mdx` file uses only `title` and `slug`. No `description` or `sidebar_position`.
69
70```
71---
72title: Page Title
73slug: /page-slug
74---
75```
76
77The `title` value is used as the page heading — do not add a duplicate `# h1` after the frontmatter.
78
79### MDX Imports
80Most pages import one or more of these at the top, after frontmatter:
81
82```
83import Icon from "@site/src/components/icon";
84import Tabs from '@theme/Tabs';
85import TabItem from '@theme/TabItem';
86import SomePartial from '@site/docs/_partial-some-content.mdx';
87```
88
89- Use `<Icon name="IconName" aria-hidden="true" />` to reference Lucide icons inline. Always include `aria-hidden="true"` and bold the button name next to it for accessibility: `<Icon name="Play" aria-hidden="true" /> **Run**`.
90- Use `<SomePartial />` to embed shared content partials.
91
92### Admonitions
93```
94:::tip
95Use for helpful tips.
96:::
97
98:::warning
99Use for potential issues.
100:::
101
102:::danger
103Use for critical warnings.
104:::
105```
106
107### Images and Assets
108```
109
110```
111
112Images go in `static/img/`. Use descriptive alt text.
113
114---
115
116## 4. Component Documentation
117
118### Component Page Template
119```
120---
121title: Component Name
122slug: /component-name
123---
124
125import Icon from "@site/src/components/icon";
126
127One-sentence description of what the component does.
128
129## Use the Component Name component in a flow
130
131Step-by-step instructions for using the component.
132
133## Component Name parameters
134
135| Name | Type | Description |
136|------|------|-------------|
137| `input_name` | MessageTextInput | Description of the input. |
138| `output_name` | Message | Description of the output. |
139```
140
141### API Documentation
142```
143---
144title: API Endpoint Name
145slug: /api-endpoint-name
146---
147
148## Endpoint
149
150`POST /api/v1/endpoint`
151
152## Request body
153
154| Parameter | Type | Description |
155|-----------|------|-------------|
156| `param` | string | Description. |
157
158## Example
159
160```bash
161curl -X POST http://localhost:7860/api/v1/endpoint \
162 -H "Authorization: Bearer your-token" \
163 -H "Content-Type: application/json" \
164 -d '{"param": "value"}'
165```
166```
167
168---
169
170## 5. Documentation Testing
171
172### Build and serve
173```bash
174cd docs
175npm run build # Build static site
176npm run serve # Serve built site locally
177```
178
179### API examples
180```bash
181make api_examples_local # Run API sample files against a local Langflow server
182make api_examples_local_syntax # Syntax-check API sample files without executing them
183```
184
185### Content Review
186- **Accuracy:** Verify all code examples work
187- **Completeness:** Ensure all features are documented
188- **Clarity:** Review for clear, concise language
189- **Navigation:** Test sidebar and cross-references
190
191### Screenshots
192- Keep screenshots up-to-date with current UI
193- Use consistent browser/OS for screenshots
194- Highlight relevant UI elements
195- Use descriptive file names
196
197---
198
199## 6. Style Guide
200
201### Writing Style
202- **Tone:** Professional but approachable
203- **Voice:** Second person ("you") for instructions
204- **Tense:** Present tense for current features
205- **Length:** Keep paragraphs short and scannable
206
207### Formatting
208- **Headers:** Use sentence case
209- **Code:** Inline code with `backticks`
210- **Emphasis:** Use **bold** for UI elements, *italic* for emphasis
211- **Lists:** Use parallel structure
212
213### Terminology
214- **Langflow:** Always capitalize
215- **Component:** Capitalize when referring to Langflow components
216- **Flow:** Capitalize when referring to Langflow flows
217- **API:** Always uppercase
218- **JSON:** Always uppercase
219
220---
221
222## 7. Deployment
223
224### Local Testing
225```bash
226cd docs
227npm run build # Build static site
228npm run serve # Serve built site locally
229```
230
231### Production Deployment
232- Documentation changes are submitted as pull requests to the **release branch**, not directly to `main`.
233- The release branch is merged to `main` as part of the release process.
234- Build artifacts go to the `build/` directory.
235- The static site is served via CDN.
236
237---
238
239## Documentation Development Checklist
240- [ ] Documentation service running with `npm run start`
241- [ ] Content follows markdown conventions
242- [ ] Code examples are tested and working
243- [ ] Images have descriptive alt text
244- [ ] Internal links are functional
245- [ ] Sidebar navigation is updated
246- [ ] Content follows style guide
247- [ ] Screenshots are current and properly formatted
248- [ ] Cross-references between related topics
249- [ ] Build succeeds with `npm run build`
250- [ ] Changes target the release branch (not `main`)
251
langflow-ai/langflow · CLAUDE.md
@@ +1 @@
1# CLAUDE.md
2
3@AGENTS.md
4@.claude/CLAUDE.md
5
6This project uses [AGENTS.md](https://agents.md/) as the standard for providing context to AI coding agents. The `@AGENTS.md` import above tells Claude Code to load `AGENTS.md` automatically; other tools that natively support `AGENTS.md` will pick it up directly. The `@.claude/CLAUDE.md` import loads the local hard-rules file (gitignored) that mirrors the PostToolUse hook policy.
7
@@ −1 +1 @@
1−---
2−description: "Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes."
3−globs:
4− - "docs/**/*.{md,mdx}"
5− - "docs/**/*.{js,jsx,ts,tsx}"
6− - "docs/package*.json"
7− - "docs/docusaurus.config.js"
8− - "docs/sidebars.js"
9− - "docs/static/**/*"
10−alwaysApply: false
11−---
1+# CLAUDE.md
122
13−# Documentation Development Guidelines
3+@AGENTS.md
4+@.claude/CLAUDE.md
145
15−## Purpose
16−Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes.
17−
18−---
19−
20−## 1. Documentation Environment Setup
21−
22−### Prerequisites
23−- **Node.js:** v22.12 LTS for runtime
24−- **Package Manager:** npm for dependency management
25−- **Documentation Framework:** Docusaurus v3
26−
27−### Documentation Service
28−```bash
29−cd docs
30−npm install # Install dependencies
31−npm run start # Start dev server
32−```
33−- Auto-reloads on documentation changes
34−- Access at: http://localhost:3000/
35−- Documentation source: `docs/`
36−
37−---
38−
39−## 2. Documentation Structure
40−
41−### Directory Layout
42−```
43−docs/
44−├── docs/ # Main documentation content
45−│ ├── agents/ # Agent and MCP guides
46−│ ├── get-started/ # Getting started guides
47−│ ├── tutorials/ # Langflow tutorials
48−│ ├── components/ # Component documentation
49−│ ├── flows/ # Guides to build, run, and test flows
50−│ ├── deployment/ # Guides for deploying and hosting a Langflow server
51−│ ├── develop/ # Guides for developing apps with Langflow
52−│ ├── support/ # Help and release notes
53−│ ├── contributing/ # Contribution guidelines
54−│ ├── api-reference/ # API documentation
55−│ └── _partial-*.mdx # Shared content partials (imported by other pages)
56−├── src/ # Custom React components
57−├── static/ # Static assets (images, etc.)
58−├── sidebars.js # Sidebar configuration
59−├── docusaurus.config.js # Main configuration
60−└── package.json # Dependencies
61−```
62−
63−---
64−
65−## 3. Writing Documentation
66−
67−### Frontmatter
68−Every `.mdx` file uses only `title` and `slug`. No `description` or `sidebar_position`.
69−
70−```
71−---
72−title: Page Title
73−slug: /page-slug
74−---
75−```
76−
77−The `title` value is used as the page heading — do not add a duplicate `# h1` after the frontmatter.
78−
79−### MDX Imports
80−Most pages import one or more of these at the top, after frontmatter:
81−
82−```
83−import Icon from "@site/src/components/icon";
84−import Tabs from '@theme/Tabs';
85−import TabItem from '@theme/TabItem';
86−import SomePartial from '@site/docs/_partial-some-content.mdx';
87−```
88−
89−- Use `<Icon name="IconName" aria-hidden="true" />` to reference Lucide icons inline. Always include `aria-hidden="true"` and bold the button name next to it for accessibility: `<Icon name="Play" aria-hidden="true" /> **Run**`.
90−- Use `<SomePartial />` to embed shared content partials.
91−
92−### Admonitions
93−```
94−:::tip
95−Use for helpful tips.
96−:::
97−
98−:::warning
99−Use for potential issues.
100−:::
101−
102−:::danger
103−Use for critical warnings.
104−:::
105−```
106−
107−### Images and Assets
108−```
109−
110−```
111−
112−Images go in `static/img/`. Use descriptive alt text.
113−
114−---
115−
116−## 4. Component Documentation
117−
118−### Component Page Template
119−```
120−---
121−title: Component Name
122−slug: /component-name
123−---
124−
125−import Icon from "@site/src/components/icon";
126−
127−One-sentence description of what the component does.
128−
129−## Use the Component Name component in a flow
130−
131−Step-by-step instructions for using the component.
132−
133−## Component Name parameters
134−
135−| Name | Type | Description |
136−|------|------|-------------|
137−| `input_name` | MessageTextInput | Description of the input. |
138−| `output_name` | Message | Description of the output. |
139−```
140−
141−### API Documentation
142−```
143−---
144−title: API Endpoint Name
145−slug: /api-endpoint-name
146−---
147−
148−## Endpoint
149−
150−`POST /api/v1/endpoint`
151−
152−## Request body
153−
154−| Parameter | Type | Description |
155−|-----------|------|-------------|
156−| `param` | string | Description. |
157−
158−## Example
159−
160−```bash
161−curl -X POST http://localhost:7860/api/v1/endpoint \
162− -H "Authorization: Bearer your-token" \
163− -H "Content-Type: application/json" \
164− -d '{"param": "value"}'
165−```
166−```
167−
168−---
169−
170−## 5. Documentation Testing
171−
172−### Build and serve
173−```bash
174−cd docs
175−npm run build # Build static site
176−npm run serve # Serve built site locally
177−```
178−
179−### API examples
180−```bash
181−make api_examples_local # Run API sample files against a local Langflow server
182−make api_examples_local_syntax # Syntax-check API sample files without executing them
183−```
184−
185−### Content Review
186−- **Accuracy:** Verify all code examples work
187−- **Completeness:** Ensure all features are documented
188−- **Clarity:** Review for clear, concise language
189−- **Navigation:** Test sidebar and cross-references
190−
191−### Screenshots
192−- Keep screenshots up-to-date with current UI
193−- Use consistent browser/OS for screenshots
194−- Highlight relevant UI elements
195−- Use descriptive file names
196−
197−---
198−
199−## 6. Style Guide
200−
201−### Writing Style
202−- **Tone:** Professional but approachable
203−- **Voice:** Second person ("you") for instructions
204−- **Tense:** Present tense for current features
205−- **Length:** Keep paragraphs short and scannable
206−
207−### Formatting
208−- **Headers:** Use sentence case
209−- **Code:** Inline code with `backticks`
210−- **Emphasis:** Use **bold** for UI elements, *italic* for emphasis
211−- **Lists:** Use parallel structure
212−
213−### Terminology
214−- **Langflow:** Always capitalize
215−- **Component:** Capitalize when referring to Langflow components
216−- **Flow:** Capitalize when referring to Langflow flows
217−- **API:** Always uppercase
218−- **JSON:** Always uppercase
219−
220−---
221−
222−## 7. Deployment
223−
224−### Local Testing
225−```bash
226−cd docs
227−npm run build # Build static site
228−npm run serve # Serve built site locally
229−```
230−
231−### Production Deployment
232−- Documentation changes are submitted as pull requests to the **release branch**, not directly to `main`.
233−- The release branch is merged to `main` as part of the release process.
234−- Build artifacts go to the `build/` directory.
235−- The static site is served via CDN.
236−
237−---
238−
239−## Documentation Development Checklist
240−- [ ] Documentation service running with `npm run start`
241−- [ ] Content follows markdown conventions
242−- [ ] Code examples are tested and working
243−- [ ] Images have descriptive alt text
244−- [ ] Internal links are functional
245−- [ ] Sidebar navigation is updated
246−- [ ] Content follows style guide
247−- [ ] Screenshots are current and properly formatted
248−- [ ] Cross-references between related topics
249−- [ ] Build succeeds with `npm run build`
250−- [ ] Changes target the release branch (not `main`)
6+This project uses [AGENTS.md](https://agents.md/) as the standard for providing context to AI coding agents. The `@AGENTS.md` import above tells Claude Code to load `AGENTS.md` automatically; other tools that natively support `AGENTS.md` will pick it up directly. The `@.claude/CLAUDE.md` import loads the local hard-rules file (gitignored) that mirrors the PostToolUse hook policy.
2517
