diff --git a/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx b/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx
deleted file mode 100644
index 3eba380..0000000
--- a/docs/guides/collaboration/migrating-from-noodl-hosted-git.mdx
+++ /dev/null
@@ -1,73 +0,0 @@
-import useBaseUrl from '@docusaurus/useBaseUrl'
-
-# Migrating from Noodl hosted Git
-
-
-
-
-
-
-
-## Introduction
-
-Any Noodl projects created in the closed source (CS) version need to be migrated from Noodls hosted Git to its own Git repository. If you downloaded Noodl after January 2024 you are probaly running the open source (OS) version, and can disregard this guide.
-
-The process of migrating is as follows:
-
-## Get in sync
-
-To not lose any of your work you need to sync all the branches in your project. This makes sure that they are up to date on your computer.
-
-To do so, open your project in CS Noodl. Then open the Version Control panel, and pull any potential changes on every branch. If you have any local changes that are unpushed you will need to push them.
-
-:::tip
-Learn more about the Version Control panel in the [version control docs](/docs/guides/collaboration/version-control).
-:::
-
-## Move the project
-
-CS Noodl projects live in system folders that are pretty cumbersome to navigate to. A strong suggestion is to move your project to an easily accessible folder.
-
-Open the Project Settings panel and click the "Open project folder" button.
-
-
-
-
-
-
-
-This will open up your file browser in the folder of the current project. Rename this folder into something better and move it to a more reasonable place on your computer.
-
-## Gotta get Git
-
-With all branches synced and the project folder moved it's time to give them a new home. For this you will be using Github.
-
-If you dont have a Github account already, now is the time to [create one](https://github.com/signup).
-
-Log in to Github and [create a new repository](https://github.com/new). In order to migrate the project you will need two pieces of information from Github:
-
-### Git Origin URL
-
-This is found in the repo in the "Quick Setup" section:
-
-
-
-
-
-
-
-:::note
-Noodl will clear out the newly created repo when pushing. However, to be on the safe side, make sure to create the repo without any `README.md` or `.gitignore` files.
-:::
-
-### Personal Access Token
-
-This is managed in your Github account settings. You can find a guide on it [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). The token can be set up to access all your repos, or a select few. Usually, allowing access to all repos is fine, but there are some security benefits in creating separate tokens for each repo. Do what works best for you, but make sure your token is able to access your newly created repository.
-
-## Hooking it up
-
-When you have your Git Origin URL and Personal Access Token you can close CS Noodl and open your project in OS Noodl (this is why it's good to have moved the project folder beforehand). When you navigate to the Version Control panel you will now see a migration notice. Click the notice and follow the steps in the popup:
-
-
-
diff --git a/docs/guides/collaboration/overview.md b/docs/guides/collaboration/overview.md
index c4a48e7..a78cc9f 100644
--- a/docs/guides/collaboration/overview.md
+++ b/docs/guides/collaboration/overview.md
@@ -4,6 +4,6 @@ hide_title: true
---
# Collaboration
-Noodl has a built-in git client to handle version control and make it easy to follow.
+Fluxscape has a built-in git client to handle version control and make it easy to follow.
-### [Start learning about version control of Noodl apps](/docs/guides/collaboration/version-control)
+### [Start learning about Version Control for Fluxscape apps](/docs/guides/collaboration/setup-version-control)
diff --git a/docs/guides/collaboration/setup-version-control.md b/docs/guides/collaboration/setup-version-control.md
new file mode 100644
index 0000000..2535305
--- /dev/null
+++ b/docs/guides/collaboration/setup-version-control.md
@@ -0,0 +1,130 @@
+# Setup Version Control
+
+## Introduction
+
+Fluxscape uses Git as its underlying version control system. Version control allows you to:
+
+- Collaborate with team members
+- Work with multiple versions of a project in parallel (branches)
+- Keep a full history of your project, locally or via a connected Git repository (e.g. GitHub)
+
+Initializing version control always starts with **local Git**.
+Connecting a remote repository is optional and done separately.
+
+---
+
+## Requirements
+
+Before setting up version control, make sure:
+
+- **Git is installed** on your machine
+ Fluxscape relies on your local Git installation.
+ - macOS: Git is usually preinstalled
+ - Windows: Install from https://git-scm.com
+- Your project is stored in a local folder
+- (Optional) A GitHub account if you want to collaborate or push to a remote repository
+
+---
+
+## Initialize Version Control (Local Git)
+
+This is the first step and enables Git **locally only**.
+
+1. Open your project in Fluxscape
+2. Open the **Version Control** panel
+3. Click **Initialize Version Control (Git)**
+
+
+
+
+
+
+
+This will:
+- Initialize Git in your project folder
+- Enable local commits and history
+- Not connect to GitHub or any remote service
+
+All changes and history remain on your machine until a remote repository is added.
+
+This setup is ideal for:
+- Solo work
+- Prototyping
+- Working offline
+- Getting started with version control
+
+---
+
+## Connect a GitHub Repository (Optional)
+
+Connecting a GitHub repository allows you to collaborate with others and back up your project remotely.
+
+Before connecting a repository in Fluxscape, make sure you either:
+- Created a GitHub repository, or
+- Were granted full access to an existing repository
+
+Fluxscape always works with a **local project folder**. If you are connecting to an existing repository, it must be cloned to your machine first.
+
+---
+
+### Step 1: Choose or create a GitHub repository
+
+You can connect:
+- An existing GitHub repository (for example, one shared with you by a collaborator), or
+- A newly created empty repository
+
+:::warning Existing repository requirement
+Fluxscape always works with a local project folder. If you are connecting to an existing project and repository, first clone the repository to your machine, import the project into Fluxscape, and then Open the Project.
+:::
+---
+
+### Step 2: Set up GitHub authentication
+
+GitHub requires authentication when pushing or pulling changes.
+
+Fluxscape uses **GitHub Personal Access Tokens**.
+
+#### Create a Personal Access Token
+1. Visit https://github.com/settings/personal-access-tokens (Or go to Github Settings > Developer Settings > Personal Access Tokens)
+
+
+
+2. Create a **fine-grained personal access token**
+
+
+
+3. Set your Expiration
+4. Select the repository you want to connect
+5. Grant **Read & write** access to repository "Contents"
+
+
+
+6. Create the Token & Copy the token (it cannot be viewed again)
+
+
+
+
+---
+
+### Step 3: Configure the Git remote in Fluxscape
+
+1. Open your project in Fluxscape
+2. Open the **Version Control** panel
+3. Click Version Control Settings (Gear Icon)
+4. Find your GitHub Repo Origin URL
+5. Paste the GitHub Repo Origin URL
+6. Paste your Personal Access Token into **GitHub Credentials**
+7. Save
+
+
+
+
+
+
+
+
+## Next Steps
+
+:::note
+Continue to [Using Version Control](./version-control) to learn how to work with commits, syncing, conflicts, and branches.
+:::
\ No newline at end of file
diff --git a/docs/guides/collaboration/version-control.md b/docs/guides/collaboration/version-control.md
index f8e6ac3..484b032 100644
--- a/docs/guides/collaboration/version-control.md
+++ b/docs/guides/collaboration/version-control.md
@@ -1,12 +1,14 @@
-# Version control
+# Using Version Control
## Introduction
-Version control has three main use cases:
+This guide explains how to work with version control in Fluxscape once Git has already been set up for your project.
+It covers day-to-day actions such as committing changes, syncing with collaborators, resolving conflicts, and working with branches.
-- Collaborating with team members
-- Working with different versions of your project in parallel (what's known as "branches")
-- Backup. All versions are backed up in the cloud
+:::note
+If you haven’t set up version control yet, see
+**[Setup Version Control](./setup-version-control)** before continuing.
+:::
@@ -14,36 +16,12 @@ Version control has three main use cases:
-Noodl uses [Git](https://git-scm.com) as the underlying version control system. The project folder is a Git repository.
-The most common way to interact with Git in Noodl is through the Version Control panel. Users comfortable with Git can use external git clients to view their Noodl projects as well.
-
-## Enabling version control
-
-To start using the version control features you need to init Git for your project. This can be done by opening the Version Control panel and clicking the "Initialize Version Control" button.
-
-
-
-
-
-
-
-This will set up all necessary files to run Git in your project. From here you can version control locally, or push it to an external Git repository. This is useful if you want to collaborate with others, or keep your project backed up on a remote server.
-
-Pushing to an external repo can be done by clicking the button labeled "To push changes set a git remote". You can also use the terminal, or a Git client like [Github Desktop](https://desktop.github.com/).
-
-:::tip
-If you're new to Git, don't forget to push your changes regularly to prevent losing your work. A good rule of thumb is to do it everytime you finish or change a feature.
-:::
-
-Any project collaborators will have to clone the project from the repo, and then open the downloaded Project Folder in Noodl.
+Fluxscape uses [Git](https://git-scm.com) as the underlying version control system. The project folder is a Git repository.
+The most common way to interact with Git in Fluxscape is through the Version Control panel. Users comfortable with Git can use external git clients to view their Fluxscape projects as well.
-The easiest way to get started with Git is through Github. Read more about creating Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories) or cloning Github repos [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
-:::note
-Noodl will clear out the newly created repo when pushing for the first time. However, to be on the safe side, make sure to create the repo without any `README.md` or `.gitignore` files.
-:::
-## The version control panel
+## The Version Control Panel
The version control panel is where you perform all actions related to version control. This includes actions such as pushing new changes to your collaborators, pulling the latest version, seeing differences between versions, merging branches, and more.
@@ -63,7 +41,7 @@ When there are changes in your project you can commit them to the version contro
-Noodl will now show you all the components and files that have changed, and by clicking them you can see the difference compared to the previous version.
+Fluxscape will now show you all the components and files that have changed, and by clicking them you can see the difference compared to the previous version.
@@ -71,7 +49,7 @@ Noodl will now show you all the components and files that have changed, and by c
-After the changes have been commited the commit is now visible in the history tab.
+After the changes have been committed the commit is now visible in the history tab.
@@ -83,7 +61,7 @@ Push your changes by clicking the button at the top that says "Push 1 local comm
## Pulling down changes
-Noodl checks if there are any changes to pull down when the version control panel is opened.
+Fluxscape checks if there are any changes to pull down when the version control panel is opened.
You can also manually check for updates by clicking the update icon
@@ -107,7 +85,7 @@ Any local changes you have, that aren't pushed, will still be there after pullin
## Conflicts
-Sometimes you and your collaborators might change the same parameter on the same node. In those cases, Noodl doesn't know which change to apply and will ask you to resolve the conflicts.
+Sometimes you and your collaborators might change the same parameter on the same node. In those cases, Fluxscape doesn't know which change to apply and will ask you to resolve the conflicts.
@@ -138,7 +116,7 @@ Create a branch by clicking the '+' icon in the version control panel's branch d
-After a branch has been created Noodl will switch to the new branch. Any changes in your project that weren't pushed will be moved to this new branch.
+After a branch has been created Fluxscape will switch to the new branch. Any changes in your project that weren't pushed will be moved to this new branch.
Changes you push will now belong to the new branch, and won't affect the other branches.
@@ -166,7 +144,7 @@ Changes from one branch can be merged into another branch. In this example, the
diff --git a/static/data/guides.js b/static/data/guides.js
index d686c22..1938f9d 100644
--- a/static/data/guides.js
+++ b/static/data/guides.js
@@ -438,20 +438,20 @@ const guides = [
items: [
{
type: 'doc',
- label: 'Version Control',
- id: 'guides/collaboration/version-control',
+ label: 'Setup Version Control',
+ id: 'guides/collaboration/setup-version-control',
imageUrl: '/img/featured-content-images/basic.png',
description:
'Learn how to use Noodls powerful version control features based on Git',
},
{
type: 'doc',
- label: 'Migrating from Noodl hosted Git',
- id: 'guides/collaboration/migrating-from-noodl-hosted-git',
+ label: 'Using Version Control',
+ id: 'guides/collaboration/version-control',
imageUrl: '/img/featured-content-images/basic.png',
description:
- 'Projects created with closed source Noodl need to be migrated for collaboration to work',
- },
+ 'Learn how to use Noodls powerful version control features based on Git',
+ }
],
},
{
diff --git a/static/docs/guides/collaboration/version-control/git-origin-form.jpg b/static/docs/guides/collaboration/version-control/git-origin-form.jpg
new file mode 100644
index 0000000..f3c9687
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/git-origin-form.jpg differ
diff --git a/static/docs/guides/collaboration/version-control/git-origin.png b/static/docs/guides/collaboration/version-control/git-origin.png
deleted file mode 100644
index 18927e0..0000000
Binary files a/static/docs/guides/collaboration/version-control/git-origin.png and /dev/null differ
diff --git a/static/docs/guides/collaboration/version-control/git-personal-access-token.jpg b/static/docs/guides/collaboration/version-control/git-personal-access-token.jpg
new file mode 100644
index 0000000..10fb41f
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/git-personal-access-token.jpg differ
diff --git a/static/docs/guides/collaboration/version-control/github-new-personal-access-token.png b/static/docs/guides/collaboration/version-control/github-new-personal-access-token.png
new file mode 100644
index 0000000..ded4b59
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/github-new-personal-access-token.png differ
diff --git a/static/docs/guides/collaboration/version-control/github-origin.jpg b/static/docs/guides/collaboration/version-control/github-origin.jpg
new file mode 100644
index 0000000..2947978
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/github-origin.jpg differ
diff --git a/static/docs/guides/collaboration/version-control/github-personal-access-token-config.jpg b/static/docs/guides/collaboration/version-control/github-personal-access-token-config.jpg
new file mode 100644
index 0000000..b3c9fd3
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/github-personal-access-token-config.jpg differ
diff --git a/static/docs/guides/collaboration/version-control/github-personal-access-token-copy.jpg b/static/docs/guides/collaboration/version-control/github-personal-access-token-copy.jpg
new file mode 100644
index 0000000..e469cfa
Binary files /dev/null and b/static/docs/guides/collaboration/version-control/github-personal-access-token-copy.jpg differ
diff --git a/static/docs/guides/collaboration/version-control/migration-wizard.mp4 b/static/docs/guides/collaboration/version-control/migration-wizard.mp4
deleted file mode 100644
index 8a0859e..0000000
Binary files a/static/docs/guides/collaboration/version-control/migration-wizard.mp4 and /dev/null differ
diff --git a/static/guides/index.json b/static/guides/index.json
index 4c4b85b..3e34c3c 100644
--- a/static/guides/index.json
+++ b/static/guides/index.json
@@ -227,8 +227,12 @@
"sectionTitle": "Collaboration",
"guides": [
{
- "title": "Version Control",
- "url": "docs/guides/collaboration/version-control"
+ "title": "Setup Version Control",
+ "url": "docs/guides/collaboration/setup-version-control"
+ },
+ {
+ "title": "Using Version Control",
+ "url": "docs/guides/collaboration/using-version-control"
},
{
"title": "Migrating from Noodl hosted Git",