docs_development.mdc in langflow-ai/langflow runs 878 words across 33 headings.
Langflow is a powerful tool for building and deploying AI-powered agents and workflows.
PythonCovers
11 of the 20 section tags
In the order a file is read inHeadings
33 headings, in the order the file writes them
01Documentation Development Guidelines
02Purpose
031. Documentation Environment Setup
04Prerequisites
05Documentation Service
062. Documentation Structure
07Directory Layout
083. Writing Documentation
09Frontmatter
10MDX Imports
11Admonitions
12Images and Assets
134. Component Documentation
14Component Page Template
15Use the Component Name component in a flow
16Component Name parameters
17API Documentation
18Endpoint
19Request body
20Example
215. Documentation Testing
22Build and serve
23API examples
24Content Review
25Screenshots
266. Style Guide
27Writing Style
28Formatting
29Terminology
307. Deployment
31Local Testing
32Production Deployment
33Documentation Development Checklist
Commands
6 commands this file writes down
Extracted from the file, verbatimnpm install
npm run start
npm run build
npm run serve
make api_examples_local
make api_examples_local_syntax
The file
.cursor/rules/docs_development.mdc
First 160 of 251 lines1---
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
91 more lines are in the file. Read the raw file.
The rest of the repository
langflow-ai/langflow ships 2 other instruction files
CLAUDE.mdAGENTS.md
A row that is not a link is a file this repository ships that this app did not freeze a sheet for. It is listed because the corpus knows it exists, and it is not linked because there is nothing here to open.
This listing
Whoever runs langflow-ai/langflow can claim it
This is yours? Claim this config and we will write to you when the measurement moves. The check is one token placed where only you can place it, and there is no account and no password.