Skip to content

Commit

Permalink
feat: Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
diegomrno committed Nov 25, 2024
1 parent 54b4787 commit 12d57e8
Show file tree
Hide file tree
Showing 47 changed files with 831 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Here we have all Vortex, VortexLauncher, VortexInstaller and other documentations.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
178 changes: 178 additions & 0 deletions docs/editor/posts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
{
"contents": [
{
"name": "editor",
"slug": "Editor",
"title": "Editor",
"sumary": "qsd",
"pages": [
{
"name": "overview",
"link": "overview.md",
"description": "",
"logo": "",
"slug": "Overview",
"subpages": [
{
"name": "overview_introduction",
"slug": "Introduction",
"description": "",
"logo": "",
"link": "overview_introduction.md"
},
{
"name": "overview_interface_tour",
"slug": "Interface tour",
"description": "",
"logo": "",
"link": "overview_interface_tour.md"
},
{
"name": "overview_docking",
"slug": "Docking",
"description": "",
"logo": "",
"link": "overview_docking.md"
}
]
},
{
"name": "manage_contents",
"link": "manage_contents.md",
"description": "",
"logo": "",
"slug": "Manage Contents",
"subpages": [
{
"name": "manage_contents_use_the_content_browser",
"slug": "Use the content browser",
"description": "",
"logo": "",
"link": "manage_contents_use_the_content_browser.md"
},
{
"name": "manage_contents_navigate_over_contents",
"slug": "Navigate over contents",
"description": "",
"logo": "",
"link": "manage_contents_navigate_over_contents.md"
},
{
"name": "manage_contents_create_or_add_contents",
"slug": "Create or add contents",
"description": "",
"logo": "",
"link": "manage_contents_create_or_add_contents.md"
},
{
"name": "manage_contents_copy_paste_delete_contents",
"slug": "Copy, pase and delete contents",
"description": "",
"logo": "",
"link": "manage_contents_copy_paste_delete_contents.md"
}
]
},
{
"name": "manage_contents",
"link": "manage_contents.md",
"description": "",
"logo": "",
"slug": "Manage Contents",
"subpages": [
{
"name": "manage_contents_use_the_content_browser",
"slug": "Use the content browser",
"description": "",
"logo": "",
"link": "manage_contents_use_the_content_browser.md"
},
{
"name": "manage_contents_navigate_over_contents",
"slug": "Navigate over contents",
"description": "",
"logo": "",
"link": "manage_contents_navigate_over_contents.md"
},
{
"name": "manage_contents_create_or_add_contents",
"slug": "Create or add contents",
"description": "",
"logo": "",
"link": "manage_contents_create_or_add_contents.md"
},
{
"name": "manage_contents_copy_paste_delete_contents",
"slug": "Copy, pase and delete contents",
"description": "",
"logo": "",
"link": "manage_contents_copy_paste_delete_contents.md"
}
]
},
{
"name": "see_and_debug",
"link": "see_and_debug.md",
"description": "",
"logo": "",
"slug": "See and Debug",
"subpages": [
{
"name": "see_and_debug_use_the_console_logs",
"slug": "Use the console logs",
"description": "",
"logo": "",
"link": "see_and_debug_use_the_console_logs.md"
}
]
},
{
"name": "settings_and_confs",
"link": "settings_and_confs.md",
"description": "",
"logo": "",
"slug": "Settings and Configurations",
"subpages": [
]
},
{
"name": "manage_logical_contents",
"link": "manage_logical_contents.md",
"description": "",
"logo": "",
"slug": "Manage logical contents",
"subpages": [
{
"name": "manage_logical_contents_add_a_module",
"slug": "Add a module",
"description": "",
"logo": "",
"link": "manage_logical_contents_add_a_module.md"
},
{
"name": "manage_logical_contents_start_stop_restart_module",
"slug": "Start, stop and restart a module",
"description": "",
"logo": "",
"link": "manage_logical_contents_start_stop_restart_module.md"
},
{
"name": "manage_logical_contents_delete_module",
"slug": "Delete a module",
"description": "",
"logo": "",
"link": "manage_logical_contents_delete_module.md"
},
{
"name": "manage_logical_contents_upgrade_a_module",
"slug": "Upgrade a module",
"description": "",
"logo": "",
"link": "manage_logical_contents_upgrade_a_module.md"
}
]
}
]
}
]
}
Empty file.
8 changes: 8 additions & 0 deletions docs/get_started/contents/get_started/first_steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# First Steps

### Introduction

Thanks to the previous two chapters, Vortex is now installed and functioning. We can now dive into the real work. In this chapter, we will cover the basic operations that allow you to use Vortex through the launcher, including:
- Creating and opening a project.
- Installing content on the system.
- Testing your setup.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### Create a Project

To create a new project, launch the Vortex Launcher and go to the **Project Management** window. In the action bar, select **"Create a New Project."**

Once on the project creation page, you will see several large sections on the right side: **"All Templates,"** **"Creative,"** **"Tools,"** and **"Maintenance."** These sections contain all the templates installed on your system. In the **"All"** section, you can filter templates to find the one you're looking for.

For this example, we will select the basic empty template.

To create this empty project, click on the template icon. On the right side, you will see the details of your new project. Here, you will need to fill in some basic information, such as:
- **Project Name**
- **Project Version**
- **Author Name**
- **Description**

You will also need to choose a version of Vortex. The versions available correspond to the versions supported by the template (not the ones you have installed). However, if you create a project with an unsupported or uninstalled version, the Vortex Launcher will automatically offer to install it for you to ensure the project runs correctly.

Once you've entered the required information, you can check the option **"Open the project after creation"** to launch the editor directly.

By clicking **"Create Project,"** the new project will be created.

Now, the newly created project will be visible in the project management section of the launcher. If it’s the most recent project you’ve created, the welcome window will offer to open it quickly for you.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Delete a Project

To delete a project from your system, launch the Vortex Launcher. Click on the desired project and then click **Delete**. Once clicked, a confirmation window will appear asking you to re-enter the project name. Once the name matches, the **Delete** button will become active, and you can proceed by clicking it.


> ⚠️ **Warning**:
> Once you click **Delete**, the project will be permanently removed, and this action is irreversible. The project will not be sent to your system's recycle bin.
> Vortex does not keep any attachments to individual projects. You can also manually delete a project by removing its installation folder, but be aware that this will also permanently erase the project.

Although the Vortex Launcher properly deletes projects, you can also manually and permanently delete a project by removing its folder from where it is installed. Vortex does not keep any attachments to individual projects.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

### Install a Content

A content item is a ready-made component that can be modified just like any other component. To install content, follow these steps:

1. **Open the Vortex Launcher**
Go to the **Static Content Manager**.

2. **Install a Content**
In the manager, select the **"Install a Content"** section.

3. **Find the Content**
Select the directory where you want to search for the content to install.

4. **Select the Content**
Once the search begins, you will see the found content displayed. Select the content you want to add.

5. **Import the Content**
After selecting the content, click **Import Contents**. A confirmation window will appear, showing the components you are about to install. Click **Install**.

> 🔧 **NOTE**:
> Once installed, the content will be available and ready to use in your projects.
Your selected content is now installed and available for use.
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### Install a Module

Vortex allows you to install modules directly onto your system, making them accessible in your projects.

> ⚠️ **IMPORTANT**:
> Installing a module on your system does not mean it will automatically work in your projects.
> *(To learn more: See the concept of Modules).*
> Vortex uses a project-based approach for your content, meaning that modules function inside your projects, not directly from your system!
However, Vortex allows you to install modules onto your system for the purpose of quickly adding them to your projects later. The modules installed on your system will be available for use in projects, depending on the editor's compatibility.

So, if a module is installed and functioning within your project but is not installed on the system, it will still work. Conversely, if a module is installed on the system but not included in a project, it will not work.

To install a module on your system and make it available for your projects, follow these steps:

1. **Open the Launcher**
Go to the **Logical Content Manager**.

2. **Import a Module**
Navigate to the **"Import a Module"** section and choose a directory, or search for new modules (for example, the "Downloads" folder if the modules come from the internet).

3. **Select Modules**
During and after the search, you'll see the found modules displayed as cards. Select the modules you want to add to your system.

4. **Import the Modules**
After selecting the modules, click **Import**. A confirmation window will appear, and you can click **Import** again to finalize the process.

> 🔧 **NOTE**:
> Although the module is now installed on your system, it won't function in your project until it's specifically added to it. Make sure to include the module within your project for it to work correctly.
Now, the selected modules will be imported into your system and ready to be added to your projects.
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Install a Plugin

Like modules, plugins can be installed on your system to be made available for addition to your projects. Installing a plugin on your system does not mean it will automatically function in the editor, but rather it makes the plugin available for use within your projects.

To install a plugin on your system and make it available in your projects, follow these steps:

1. **Open the Launcher**
Go to the **Logical Content Manager**.

2. **Import a Plugin**
Navigate to the **"Import a Plugin"** section and select a directory, or search for new plugins (for example, the "Downloads" folder if the plugins come from the internet).

3. **Select Plugins**
During and after the search, you will see the found plugins displayed as cards. Select the plugins you want to add to your system.

4. **Import the Plugins**
After selecting the plugins, click **Import**. A confirmation window will appear, and you can click **Import** again to finalize the process.

> 🔧 **NOTE**:
> Although the plugin is now installed on your system, it won't function in your project until it's specifically added to it. Make sure to include the plugin within your project for it to work correctly.
Now, the selected plugins will be imported into your system and ready to be added to your projects.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### Install a Project

Vortex allows you to create your own projects, but it also enables you to install projects from external sources.
To install a new project, make sure the project you want to install is present on your system.

1. **Open the Launcher**
Go to the **Project Management** window and click on **"Import a Project"** next to the **"Create a Project"** button.

2. **Select the Project Directory**
Choose the directory that contains the project you want to install. The search will begin, and you will see a list of all installable projects.

3. **Select and Import**
Click on the project(s) you wish to install, then click **Import**. A confirmation window will appear asking you to confirm your action.

Once confirmed, the project will be copied to your project's directory. After that, the source project can be deleted, as it has already been copied to the installation directory.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### Install a Template

A template serves as a foundation to create a pre-built component or to start a project based on an existing base. A template can be a project base or a component base that can be created in the editor. Regardless of the type of template, to import a template, follow these steps:

1. **Open the Vortex Launcher**
Go to the **Static Content Manager**.

2. **Import a Template**
In the manager, go to the **"Import a Template"** section.

3. **Find Your Template**
Locate the installation directory containing the templates you wish to install.

4. **Select the Templates**
Once the search begins, you will see the available templates displayed as cards. Select the templates you wish to add.

5. **Import the Templates**
After selecting the templates, click **Import Templates**. A confirmation window will show the templates you are about to add, then click **Import**.

> 🔧 **NOTE**:
> Once imported, your templates will be available where they need to function, whether for creating a project or adding components.
Now, your selected templates will be available to use in the project creator or when adding components.
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Open a Project

To open a project, whether it's one you've created or from an external source, simply go to the **Project Manager**. There, you will see a list of all the projects installed on your system.

To open a project, click on it, and in the sidebar, click **Open**. If the project is already open, a window will notify you. Note that you can open a single project in multiple editors, but **be cautious**: some modules may not work properly if opened multiple times in different editors.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### What’s Next

You now have a complete understanding of Vortex Launcher and how to manage Vortex through it. But there’s more to explore! Here are some other sections that might interest you:

- **Editor**: This section covers everything you need to know about using the editor and managing your content, features, and tools.
- **Make, Transform, Repair**: This section will likely be of the most interest to you. It shows how to use modules to create all kinds of things, or how to use tools to diagnose, transform, or repair.
- **Develop with Vortex**: This section provides all the resources you need to develop your own modules, plugins, templates, or content.
Loading

0 comments on commit 12d57e8

Please sign in to comment.