Skip to content

Commit 235aaa0

Browse files
committed
feat(docs,styles,llms): add docs
1 parent 3a80dfe commit 235aaa0

5 files changed

Lines changed: 184 additions & 5 deletions

File tree

content/en/docs/021.llms.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
description: Supercharge your visual programming workflow with AI - Learn how to integrate Rete.js documentation with AI coding assistants for smarter node editor development
3+
keywords: llms.txt,visual programming ai,node editor ai,rete.js ai,cursor,windsurf,copilot,claude,gemini,chatgpt
4+
---
5+
6+
# LLMs.txt
7+
8+
Enhance your visual programming experience with AI tools that understand Rete.js node editor patterns, dataflow concepts, and plugin architecture.
9+
10+
## What is LLMs.txt? {#what-is-llms}
11+
12+
Building node editors and visual programming interfaces involves unique patterns and concepts that differ from traditional application development. Our AI integration through [LLMs.txt](https://llmstxt.org/) helps coding assistants understand:
13+
14+
- **Node-based architecture** and connection patterns
15+
- **Dataflow vs Control flow** processing paradigms
16+
- **Plugin composition** for extensible editors
17+
- **Multi-framework rendering** (React, Vue, Angular, Svelte)
18+
- **Graph processing** and manipulation techniques
19+
20+
This enables AI tools to provide contextually accurate suggestions for your visual programming projects.
21+
22+
## Resources {#resources}
23+
24+
Our documentation is optimized for AI consumption through specialized endpoints that understand visual programming workflows:
25+
26+
- **[llms.txt](/llms.txt)** - Essential node editor concepts, core APIs, and quick reference patterns
27+
- **[llms-full.txt](/llms-full.txt)** - Complete visual programming knowledge base including advanced patterns, plugin architecture, and processing engines
28+
29+
These endpoints are continuously updated to reflect the latest in node editor development practices and framework capabilities.
30+
31+
## How to Use {#how-to-use}
32+
33+
You can integrate Rete.js documentation with any AI coding assistant by providing the LLMs.txt URLs as context. This gives the AI comprehensive knowledge about node editor development patterns and best practices.
34+
35+
### Basic integration steps
36+
37+
1. Copy the LLMs.txt URL: `https://retejs.org/llms.txt` (or `llms-full.txt` for complete docs)
38+
2. Reference it in your AI tool's context or conversation
39+
3. Ask questions about Rete.js development, node editor patterns, or get code suggestions
40+
41+
### VS Code GitHub Copilot
42+
43+
Add the LLMs.txt URL to your workspace for enhanced context-aware suggestions:
44+
45+
1. Create a `.copilot-instructions.md` file in your project root
46+
2. Add the reference:
47+
```markdown
48+
# Copilot Instructions
49+
50+
For Rete.js development, reference the documentation at:
51+
https://retejs.org/llms-full.txt
52+
53+
Focus on node editor patterns, dataflow programming, and plugin architecture.
54+
```
55+
56+
3. Copilot will now understand Rete.js concepts when providing code completions and suggestions
57+
58+
### Google Gemini Chat
59+
60+
Reference the documentation directly in your conversation:
61+
62+
```
63+
I'm building a node editor with Rete.js. Please review the documentation at https://retejs.org/llms-full.txt and help me create a custom node that processes image data through multiple transformation steps.
64+
```
65+
66+
### Model Context Protocol (MCP)
67+
68+
MCP-compatible tools like Context7 automatically discover and fetch the Rete.js documentation as context to AI models:
69+
70+
1. The complete Rete.js documentation is automatically loaded as context for AI conversations
71+
2. AI models have persistent access to node editor patterns, plugin architecture, and best practices
72+
3. No manual setup required - the context is always available
73+
74+
This approach ensures every AI interaction has comprehensive Rete.js knowledge without any configuration.

content/uk/docs/021.llms.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
description: Пришвидште ваш робочий процес візуального програмування за допомогою ШІ - Дізнайтеся, як інтегрувати документацію Rete.js з асистентами кодування ШІ для розумнішої розробки редакторів вузлів
3+
keywords: llms.txt,візуальне програмування ші,редактор вузлів ші,rete.js ші,cursor,windsurf,copilot,claude,gemini,chatgpt
4+
---
5+
6+
# LLMs.txt
7+
8+
Покращте свій досвід візуального програмування за допомогою інструментів ШІ, які розуміють шаблони редакторів вузлів Rete.js, концепції потоків даних та архітектуру плагінів.
9+
10+
## Що таке LLMs.txt? {#what-is-llms}
11+
12+
Створення редакторів вузлів та інтерфейсів візуального програмування включає унікальні шаблони та концепції, які відрізняються від традиційної розробки додатків. Наша інтеграція з ШІ через [LLMs.txt](https://llmstxt.org/) допомагає асистентам кодування зрозуміти:
13+
14+
- **Архітектуру на основі вузлів** та шаблони з'єднань
15+
- Парадигми обробки **потоків даних проти потоків управління**
16+
- **Композицію плагінів** для розширюваних редакторів
17+
- **Багатофреймворкове рендерінг** (React, Vue, Angular, Svelte)
18+
- Техніки **обробки та маніпулювання графами**
19+
20+
Це дозволяє інструментам ШІ надавати контекстуально точні пропозиції для ваших проектів візуального програмування.
21+
22+
## Ресурси {#resources}
23+
24+
Наша документація оптимізована для споживання ШІ через спеціалізовані точки доступу, які розуміють робочі процеси візуального програмування:
25+
26+
- **[llms.txt](/llms.txt)** - Основні концепції редакторів вузлів, базові API та швидкі довідкові шаблони
27+
- **[llms-full.txt](/llms-full.txt)** - Повна база знань візуального програмування, включаючи розширені шаблони, архітектуру плагінів та обробні движки
28+
29+
Ці точки доступу постійно оновлюються, щоб відображати найновіші практики розробки редакторів вузлів та можливості фреймворків.
30+
31+
## Як використовувати {#how-to-use}
32+
33+
Ви можете інтегрувати документацію Rete.js з будь-яким асистентом кодування ШІ, надавши URL-адреси LLMs.txt як контекст. Це дає ШІ всебічні знання про шаблони розробки редакторів вузлів та кращі практики.
34+
35+
### Основні кроки інтеграції
36+
37+
1. Скопіюйте URL LLMs.txt: `https://retejs.org/llms.txt` (або `llms-full.txt` для повної документації)
38+
2. Посилайтеся на нього в контексті вашого інструменту ШІ або розмові
39+
3. Задавайте питання про розробку Rete.js, шаблони редакторів вузлів або отримуйте пропозиції коду
40+
41+
### VS Code GitHub Copilot
42+
43+
Додайте URL LLMs.txt до вашого робочого простору для покращених контекстно-залежних пропозицій:
44+
45+
1. Створіть файл `.copilot-instructions.md` в корені вашого проекту
46+
2. Додайте посилання:
47+
```markdown
48+
# Інструкції Copilot
49+
50+
Для розробки Rete.js звертайтеся до документації за адресою:
51+
https://retejs.org/llms-full.txt
52+
53+
Зосередьтеся на шаблонах редакторів вузлів, програмуванні потоків даних та архітектурі плагінів.
54+
```
55+
56+
3. Тепер Copilot розумітиме концепції Rete.js при наданні автодоповнень коду та пропозицій
57+
58+
### Google Gemini Chat
59+
60+
Посилайтеся на документацію безпосередньо у вашій розмові:
61+
62+
```
63+
Я створюю редактор вузлів з Rete.js. Будь ласка, перегляньте документацію за адресою https://retejs.org/llms-full.txt і допоможіть мені створити користувацький вузол, який обробляє дані зображень через кілька кроків трансформації.
64+
```
65+
66+
### Model Context Protocol (MCP)
67+
68+
Інструменти, сумісні з MCP, такі як Context7, автоматично виявляють та завантажують документацію Rete.js як контекст для моделей ШІ:
69+
70+
1. Повна документація Rete.js автоматично завантажується як контекст для розмов з ШІ
71+
2. Моделі ШІ мають постійний доступ до шаблонів редакторів вузлів, архітектури плагінів та кращих практик
72+
3. Не потрібно ручного налаштування - контекст завжди доступний
73+
74+
Цей підхід забезпечує, що кожна взаємодія з ШІ має всебічні знання Rete.js без будь-якої конфігурації.

nuxt.config.ts

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,27 @@ export default defineNuxtConfig({
2727
},
2828
llms: {
2929
domain: 'https://retejs.org',
30-
title: 'Rete.js Documentation',
31-
sections: [],
30+
title: 'Rete.js',
31+
sections: [
32+
{
33+
title: 'Documentation',
34+
contentCollection: 'content',
35+
contentFilters: [
36+
{ field: 'extension', operator: '=', value: 'md' },
37+
{ field: 'path', operator: 'LIKE', value: '/en/docs%' },
38+
]
39+
},
40+
{
41+
title: 'Examples',
42+
contentCollection: 'content',
43+
contentFilters: [
44+
{ field: 'extension', operator: '=', value: 'md' },
45+
{ field: 'path', operator: 'LIKE', value: '/en/examples%' },
46+
]
47+
},
48+
],
3249
full: {
33-
title: 'Rete.js Full Documentation',
34-
description: 'Complete documentation for Rete.js - a modular framework for visual programming'
50+
title: 'Rete.js Full'
3551
}
3652
},
3753
site: {

src/assets/styles/common.sass

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ h1, h2, h3, h4, div
3636
scroll-margin-top: var(--header-offset)
3737

3838
.markdown
39-
ul
39+
ul,ol
4040
margin: 0 1.5em 1em 1.5em
4141
+phone
4242
margin: 0.5em 1.5em

src/server/plugins/llms.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import { defineNitroPlugin } from 'nitropack/runtime'
2+
3+
export default defineNitroPlugin((nitroApp: any) => {
4+
nitroApp.hooks.hook('llms:generate', (event: string, options: any) => {
5+
const domain = options.domain
6+
7+
for (const section of options.sections) {
8+
for (const link of section.links) {
9+
if (link.href.startsWith(`${domain}/en/`)) {
10+
link.href = link.href.replace(`${domain}/en/`, `${domain}/`)
11+
}
12+
}
13+
}
14+
})
15+
})

0 commit comments

Comments
 (0)