Merge pull request #138 from code0-tech/feat/initial-docs

Initial docs

Author: nicosammito

app/(home)/page.tsx

@@ -1,7 +1,7 @@
 export default function HomePage() {
     return (
         <script dangerouslySetInnerHTML={{__html:
-            `window.location.replace("./code0/${process.env.NEXT_PUBLIC_ARTIFACT_VIEWER === "true" ? "index.html" : ""}")`
+            `window.location.replace("./general/introduction/${process.env.NEXT_PUBLIC_ARTIFACT_VIEWER === "true" ? "index.html" : ""}")`
         }}/>
     );
 }

content/general/changelog.md

@@ -1,3 +1,81 @@
 ---
 title: Changelog
----
+icon: IconRestore
+---
+
+All notable changes to the CodeZero software will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Support for OpenTelemetry within the frontend application of sculptor capturing logs, traces, metrics and errors.
+- New textarea component inside UI library of pictor.
+- Variables and their corresponding Node are now highlighted inside the flow editor.
+- New sidebar within the frontend application of sculptor.
+- Runtime usage calculation on runtime.
+- Support for bigger number values.
+- New remove digits and has digits functions.
+- A flow can be disabled to be updated to the runtime. We've implemented a reasoning field to explain why the flow is disabled.
+- Delete user mutation for administrators.
+- Implement flow validation on backend side.
+- License management in cloud.
+- Redirect option on login or registration within cloud version.
+- Runtime support for actions build with our Action SDK.
+
+### Changed
+
+- Switched to TypeScript for RuntimeFunction, Function, Flow and DataType definitions. This generelly improves type safety and increased reliability of suggestion and validation.
+- Runtime status is now more accurate and has more details and also exposes features installed on the runtime.
+- Moving dashboard components from UI library named pictor to frontend application named sculptor.
+- New DataTypeType input based on custom type language.
+
+### Fixed
+
+- Correct naming of variables inside suggestion.
+- Uncaught TypeError: can't access property "push", n.settings. nodes are undefined
+- The flow creation menu shows even though there is no flow type available.
+- Role creation page back link is broken.
+- Cron flow definition is wrong.
+- Number is always displayed with a decimal point. It not depends on the value of the number.
+- Prevent role deletion if no member has a different admin role.
+- Change foreign key from namespace_projects(primary_runtime_id) to runtimes(id) from cascade to restrict.
+- Ensure a project always has a primary runtime if it contains flows.
+- std::number::math Panics when second number is bigger than first.
+- REST adapter returns ProtoJson not JSON.
+- Wrong parameter description for HTTP Status code.
+- Project slug input validation is missing.
+- NodeParameter is possible to be an empty array. Fallback to FunctionParameterDefinition.
+- Input fields error when not filled.
+- Create new project page go back link is broken.
+- Go back button link is broken on members add page.
+- Sagittarius version is a placeholder.
+- Create role mutation and screen are missing and not linked.
+- Remove old project tab fragmental component under [namespaceId].
+- ReferenceValue missing fields during flow update.
+- Type OBJECT and Function std::object::set have wrong signature.
+- Validation for trigger doesn't exist.
+
+## [[0.0.0-canary-2356067148-c06e576791513b10dbcb10aa3b0420b87178a205]](https://github.com/code0-tech/codezero/releases/tag/0.0.0-canary-2356067148-c06e576791513b10dbcb10aa3b0420b87178a205) - 2026-02-28
+
+### Added
+
+- Create, delete and update runtimes
+- Create and delete flows
+- Create, delete and update organizations
+- Create, delete and update projects
+- Invite and remove members
+- Create, delete and update roles and permissions
+- Assign and remove roles on members
+- Assign and remove runtimes on projects
+- Update application restrictions (Organizations creation, User registration, Display admin status)
+- Set legal pages
+- Add next nodes inside flows
+- Update parameters of nodes
+- Update flow settings
+- Execute flows over runtime
+- Use variables and nested nodes in flows
+- Support for REST flows
+- Login, register and logout
+- Forgot password, reset password and email verification

content/general/install.mdx

@@ -0,0 +1,168 @@
+---
+title: Installation
+icon: IconDownload
+---
+
+
+
+import {Step, Steps} from 'fumadocs-ui/components/steps';
+
+This guide will walk you through the deployment of CodeZero using Docker. Currently, CodeZero is in active development,
+and we are focused on building our community of early adopters. Follow these steps to set up your environment and
+connect your first runtime.
+
+## Prerequisites
+
+Before beginning, ensure you have the following installed on your system:
+
+- Git
+- Docker and Docker Compose
+
+<Steps>
+
+    <Step>
+
+        ## Clone the latest release
+
+        To ensure stability, we recommend using the latest release. Run the following command to clone the
+        repository:
+
+        Get the newest release version from the [CodeZero GitHub releases page](https://github.com/code0-tech/codezero/releases)
+
+        ```bash
+        git clone --branch <version> https://github.com/code0-tech/codezero.git
+        ```
+
+        Navigate to the deployment directory:
+
+        ```bash
+        cd codezero/docker-compose/
+        ```
+
+    </Step>
+    <Step>
+        ## Configure environment variables
+
+        CodeZero uses an `.env` file to manage initial credentials and system settings. Create or edit the file:
+
+        ```bash
+        nano .env
+        ```
+
+        ### The .env template
+
+        Ensure your `.env` file contains the following variables. Pay close attention to the Root Credentials and the
+        Image
+        Edition.
+
+        ```bash
+        # IDE config
+        HOSTNAME=localhost
+        HTTP_PORT=80
+        HTTPS_PORT=443
+        SSL_ENABLED=false
+        SSL_CERT_FILE= # must be located in ./certs, defaults to "<hostname>.pem"
+        SSL_KEY_FILE= # must be located in ./certs, defaults to "<hostname>.key"
+
+        INITIAL_ROOT_PASSWORD=root
+        INITIAL_ROOT_MAIL=root@code0.tech
+
+        # Runtime config
+        AQUILA_SAGITTARIUS_URL=http://nginx:80
+        AQUILA_SAGITTARIUS_TOKEN=
+        DRACO_REST_PORT=8084
+
+        # Active services
+        COMPOSE_PROFILES=ide,runtime
+
+        # Image config
+        IMAGE_REGISTRY=registry.gitlab.com/code0-tech/packages
+        IMAGE_TAG= # version
+        IMAGE_EDITION= # ce or ee
+
+        # Internal config options
+        SAGITTARIUS_RAILS_HOST=sagittarius-rails-web
+        SAGITTARIUS_RAILS_PORT=3000
+        SAGITTARIUS_GRPC_HOST=sagittarius-grpc
+        SAGITTARIUS_GRPC_PORT=50051
+        SAGITTARIUS_LOG_LEVEL=info
+        SCULPTOR_HOST=sculptor
+        SCULPTOR_PORT=3000
+        POSTGRES_HOST=postgres
+        POSTGRES_PORT=5432
+        POSTGRES_DB=sagittarius_production
+        POSTGRES_USER=sagittarius
+        POSTGRES_PASSWORD=sagittarius
+        ```
+
+        ### Key parameters:
+
+        - `INITIAL_ROOT_MAIL`: The email address for the primary administrator.
+        - `INITIAL_ROOT_PASSWORD`: The secure password for your first login.
+        - `IMAGE_EDITION`: Set this to ce for the Community Edition or ee for the Enterprise Edition. This
+        determines which Docker images will be pulled.
+
+    </Step>
+    <Step>
+
+        ## Initial deployment
+
+        Start the CodeZero containers in detached mode:
+
+        ```bash
+        docker compose up -d
+        ```
+
+        Once the containers are running, you can access the CodeZero Dashboard via your browser (typically
+        at http://localhost:3000).
+
+    </Step>
+    <Step>
+
+        ## Connecting the runtime
+
+        A "Runtime" is the engine that executes your flows. To activate it, you must generate a unique token within the
+        dashboard and link it to your configuration.
+
+        ### Login
+
+        Log in to the dashboard using the `INITIAL_ROOT_MAIL` and `INITIAL_ROOT_PASSWORD` you defined in your `.env`
+        file.
+
+        ![CodeZero Thumbnail](../../public/CodeZero_Login.png)
+
+        ### Create organization or navigate to personal workspace
+
+        ![CodeZero Thumbnail](../../public/CodeZero_Install_Overview.png)
+
+        ### Navigate to runtimes
+
+        ![CodeZero Thumbnail](../../public/CodeZero_Install_Click-on-Runtime.png)
+
+        ### Create new runtime
+
+        ![CodeZero Thumbnail](../../public/CodeZero_Install_Create-Runtime.png)
+
+        ### Copy the generated token
+
+        ![CodeZero Thumbnail](../../public/CodeZero_Install_Copy-Token.png)
+
+        ### Update your `.env` file
+
+        Update your .env file with the copied token at `AQUILA_SAGITTARIUS_TOKEN` and save the file.
+
+    </Step>
+    <Step>
+
+        ## Finalize the setup
+
+        For the changes to take effect and for the runtime to authenticate correctly, restart the containers:
+
+        ```bash
+        docker compose restart
+        ```
+    </Step>
+
+</Steps>
+
+Your CodeZero instance is now fully configured and ready to manage your enterprise flows and organizational structures.

content/general/introduction.md

@@ -1,3 +1,46 @@
 ---
 title: Introduction
----
+icon: IconRocket
+---
+
+CodeZero is a versatile open-source platform designed to streamline how businesses manage operations, automate complex
+processes, and organize professional ecosystems. In a corporate world where data and tasks are often scattered across
+various tools, CodeZero provides a centralized architecture to bring your projects, teams, and business logic into one
+unified workspace.
+
+![CodeZero Thumbnail](../../public/CodeZero_Banner.png)
+
+## Revolutionizing Business Process Management
+
+At its core, CodeZero is built around the concept of Flows. A Flow is a visual representation of a business process,
+where individual steps are connected to automate logic, data handling, and integrations. For enterprise users, this
+means the ability to transform manual, time-consuming procedures into efficient, automated systems that run reliably in
+the background.
+
+## Enterprise Grade Capabilities
+
+CodeZero is engineered to meet the demands of modern B2B environments through several key pillars:
+
+- Organizational Hierarchy: Manage complex structures with ease. You can define Organizations, create specific Projects,
+  and manage Members with granular precision.
+
+- Role Based Access Control: Security and compliance are central to any enterprise. CodeZero allows you to define
+  specific Roles and permissions, ensuring that every team member has exactly the access they need and nothing more.
+
+- Scalable Infrastructure: The platform is designed to grow alongside your company. Whether you are managing a single
+  department or an international corporation, the modular system adapts to your scale.
+
+- Hybrid Deployment & Data Sovereignty: For companies with strict data privacy requirements, CodeZero offers unique
+  flexibility. You can utilize our interface while keeping your actual data processing on your own local infrastructure,
+  maintaining full control over your information.
+
+## The Future of Collaborative Automation
+
+CodeZero bridges the gap between high-level organizational management and granular task automation. It acts as the
+digital backbone for your company, allowing teams to collaborate on complex projects while the system handles the
+repetitive "heavy lifting."
+
+We are currently focused on growing a professional community of early adopters and contributors. This is an opportunity
+for businesses to help shape a tool that prioritizes modularity, transparency, and efficiency. By integrating CodeZero
+into your workflow, you are not just adopting a tool; you are joining a movement toward more open, adaptable, and
+powerful business management.

content/general/meta.json

@@ -1,4 +1,11 @@
 {
   "title": "General",
-  "root": true
+  "root": true,
+  "pages": [
+    "introduction",
+    "install",
+    "changelog",
+    "tutorials",
+    "troubleshooting"
+  ]
 }

content/general/troubleshooting.md

@@ -1,3 +1,6 @@
 ---
 title: Troubleshooting
----
+icon: IconExclamationCircle
+---
+
+## Under construction

content/general/tutorials.md

@@ -1,3 +1,6 @@
 ---
 title: Tutorials
----
+icon: IconBook2
+---
+
+## Under construction