From ec7140c6c7906df899b56e5943eacb208d9ee097 Mon Sep 17 00:00:00 2001 From: Ricardo Loureiro Date: Thu, 11 Apr 2024 13:37:03 +0100 Subject: [PATCH 1/5] Add Overture logo to the documentation --- moonwave.toml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/moonwave.toml b/moonwave.toml index 3d79f7b..4f07541 100644 --- a/moonwave.toml +++ b/moonwave.toml @@ -1 +1,11 @@ apiCategories = ["Library Management", "Instance Retrieval"] + +[docusaurus] +tagline = "Source code management engine for Roblox." + +[navbar] +title = "" + +[navbar.logo] +alt = "Overture Logo" +src = "https://github.com/devSparkle/overture-vscode/blob/main/assets/icon-dark.png" From c342f074d0ec9af3dc4241eb35038d217e4feb9e Mon Sep 17 00:00:00 2001 From: Ricardo Loureiro Date: Thu, 12 Dec 2024 17:28:57 +0000 Subject: [PATCH 2/5] Add documentation on migrating to V2 --- docs/Migrating.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/Migrating.md diff --git a/docs/Migrating.md b/docs/Migrating.md new file mode 100644 index 0000000..01095ab --- /dev/null +++ b/docs/Migrating.md @@ -0,0 +1,13 @@ +# Migrating to V2 + +Most of the public-facing API of Overture has changed with the release of version 2. + +StarterPlayerScript and StarterCharacterScript tags have been completely removed, in favour of RunContex. This will likely require significant changes. + +```regex +(Get|GetLocal|WaitFor)?(RemoteEvent|RemoteFunction|BindableEvent|BindableFunction)\((".*?")\) +``` + +```regex +\1("\2", \3) +``` From eca78de40aaadd349e0231d5a06ef42469472022 Mon Sep 17 00:00:00 2001 From: Ricardo Loureiro Date: Thu, 12 Dec 2024 17:29:03 +0000 Subject: [PATCH 3/5] Improve documentation --- moonwave.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/moonwave.toml b/moonwave.toml index 4f07541..733e315 100644 --- a/moonwave.toml +++ b/moonwave.toml @@ -9,3 +9,7 @@ title = "" [navbar.logo] alt = "Overture Logo" src = "https://github.com/devSparkle/overture-vscode/blob/main/assets/icon-dark.png" + +[home] +enabled = true +includeReadme = false From 3f05df9b652546e38b44e4c56e39769c2965736a Mon Sep 17 00:00:00 2001 From: Ricardo Loureiro Date: Thu, 12 Dec 2024 17:30:22 +0000 Subject: [PATCH 4/5] Update node --- .github/workflows/documentation.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index ecc1baf..73a4eba 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,7 +24,6 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v4 with: - node-version: 16.x cache: "npm" cache-dependency-path: "**/.github/workflows/*.yml" - name: Build From 448f007c0f4c1cc0267791d3e2b60a5b2ea2ef56 Mon Sep 17 00:00:00 2001 From: Ricardo Loureiro Date: Thu, 12 Dec 2024 18:25:28 +0000 Subject: [PATCH 5/5] Revert "Add documentation on migrating to V2" This reverts commit c342f074d0ec9af3dc4241eb35038d217e4feb9e. --- docs/Migrating.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 docs/Migrating.md diff --git a/docs/Migrating.md b/docs/Migrating.md deleted file mode 100644 index 01095ab..0000000 --- a/docs/Migrating.md +++ /dev/null @@ -1,13 +0,0 @@ -# Migrating to V2 - -Most of the public-facing API of Overture has changed with the release of version 2. - -StarterPlayerScript and StarterCharacterScript tags have been completely removed, in favour of RunContex. This will likely require significant changes. - -```regex -(Get|GetLocal|WaitFor)?(RemoteEvent|RemoteFunction|BindableEvent|BindableFunction)\((".*?")\) -``` - -```regex -\1("\2", \3) -```