This repository contains the documentation website for RUNE Interface, a visual workflow editor for building flows with Luau.
The documentation is built using Docusaurus, a modern static website generator.
RUNE (Rapid Unified Node Editor) is a visual workflow editor that lets you build automation flows, data processing pipelines, and complex logic without writing traditional code. Instead of writing code line by line, you drag nodes onto a canvas, connect them together, and run your flow immediately.
- Introduction: Overview of RUNE and key concepts
- RUNE Interface: Getting started guide for the graphical application
- RUNE CLI: Getting started guide for the command-line tool
- Luau API: Complete reference for the Luau scripting API
- Core Systems: SessionState, FlowFile, Logger, and more
- Functions: Individual function documentation with examples
- Nodes: Complete reference for all available nodes
- Flow Control, Events, Session State, Data Types, Comparisons
- File Operations, JSON/YAML/INI/CSV Operations, Crypto, and Utilities
yarnyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
The documentation will be available at http://localhost:3000
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
The documentation is deployed to GitHub Pages at https://blazium-engine.github.io/rune_docs/
Documentation improvements and corrections are welcome! Please ensure that:
- Documentation is clear and concise, suitable for junior engineers
- Code examples are accurate and tested
- Node documentation includes all inputs, outputs, and special notes
- Links to related documentation are included where appropriate
We also welcome contributions for new language localizations! See the Contributing Localizations section below for details.
RUNE Interface supports multiple languages through .po (Portable Object) files. If you'd like to contribute a new language translation, here's how:
- Use the template: Start with the base language file
languages/en_US.poas your template - Read the guide: See the detailed Localization Guide for step-by-step instructions on creating translations
- Create your translation:
- Copy
languages/en_US.poand rename it to match your language code (e.g.,fr_FR.pofor French,de_DE.pofor German) - Update the file header with your language code, native name, and English name
- Translate all
msgstrentries to your target language
- Copy
Important: All localization PRs must have an associated Issue Ticket assigned before submission.
-
Create or find an Issue Ticket:
- Check if there's already an issue for your language
- If not, create a new issue requesting support for your language
- Wait for the issue to be assigned to you
-
Prepare your PR:
- Place your
.pofile in the root-levellanguages/directory (notdocs/languages/) - Ensure your file follows the same format as
en_US.po - Test your translation locally before submitting
- Place your
-
Submit your Pull Request:
- Reference the Issue Ticket number in your PR description (e.g., "Fixes #123" or "Addresses #456")
- Include the following information in your PR:
- Language code (e.g.,
fr_FR,de_DE) - Native name of the language
- English name of the language
- Translation completeness status (e.g., "All 326 strings translated")
- Any notes about the translation
- Language code (e.g.,
Language files must be placed in the root-level languages/ directory (not docs/languages/). These files are compiled into the engine binary during the build process, so they need to be in the correct location for the build system to find them.
Translation: Français (fr_FR)
Language Code: fr_FR
Native Name: Français
English Name: French
This PR adds French translation support for RUNE Interface.
All 326 strings have been translated and tested.
Fixes #123