From 44a689afb466f16d9457b1df03682147120e7ee5 Mon Sep 17 00:00:00 2001 From: thepaperpilot Date: Sun, 18 Feb 2024 09:52:22 -0600 Subject: [PATCH] Update source code links and references to incremental.social --- docs/.vitepress/config.js | 8 ++++---- docs/.vitepress/theme/custom.css | 4 ++++ docs/guide/getting-started/examples.md | 2 +- docs/guide/getting-started/setup.md | 18 ++++-------------- docs/guide/getting-started/updating.md | 6 +++--- docs/index.md | 2 +- package.json | 6 +++--- 7 files changed, 20 insertions(+), 26 deletions(-) diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index d213f17d..1e91d21f 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -21,8 +21,8 @@ module.exports = { themeConfig: { logo: "/favicon.svg", editLink: { - pattern: "https://github.com/profectus-engine/profectus-docs/edit/main/docs/:path", - editLinkText: "Edit this page on GitHub" + pattern: "https://code.incremental.social/profectus/profectus-docs/edit/main/docs/:path", + editLinkText: "Edit this page on Incremental Social" }, nav: [ { text: "Guide", link: "/guide/", activeMatch: "^/guide/" }, @@ -31,7 +31,7 @@ module.exports = { ], socialLinks: [ { icon: "discord", link: "https://discord.gg/yJ4fjnjU54" }, - { icon: "github", link: "https://github.com/profectus-engine/Profectus" } + { icon: { svg: '' }, link: "https://code.incremental.social/profectus/Profectus" } ], sidebar: { "/guide/": [ @@ -44,7 +44,7 @@ module.exports = { { text: "Updating Profectus", link: "/guide/getting-started/updating" }, { text: "Your First Layer", link: "/guide/getting-started/first-layer" }, { text: "Example Projects", link: "/guide/getting-started/examples" }, - { text: "Profectus Changelog", link: "https://github.com/profectus-engine/Profectus/blob/main/CHANGELOG.md" } + { text: "Profectus Changelog", link: "https://code.incremental.social/profectus/Profectus/blob/main/CHANGELOG.md" } ] }, { diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 114c159d..9e222a0b 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -52,3 +52,7 @@ body { .vp-doc h3 + h4 { margin-top: 16px; } + +.VPSocialLink > svg { + width: 30px !important; +} diff --git a/docs/guide/getting-started/examples.md b/docs/guide/getting-started/examples.md index 292e0013..26e14cdb 100644 --- a/docs/guide/getting-started/examples.md +++ b/docs/guide/getting-started/examples.md @@ -20,7 +20,7 @@ This is a project that's still under development but is a good resource for thin ## TMT-Demo -[View Source](https://github.com/profectus-engine/tmt-demo) | [View Project](https://profectus-engine.github.io/TMT-Demo/) +[View Source](https://code.incremental.social/profectus/TMT-Demo) | [View Project](https://profectus.pages.incremental.social//TMT-Demo/) A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay. diff --git a/docs/guide/getting-started/setup.md b/docs/guide/getting-started/setup.md index b464724f..3955421b 100644 --- a/docs/guide/getting-started/setup.md +++ b/docs/guide/getting-started/setup.md @@ -9,13 +9,13 @@ For local development, you will need the following tools: - [git](https://git-scm.com/downloads) - [node](https://nodejs.org/en/download/) -Create a new project from the [Profectus repository](https://github.com/profectus-engine/Profectus) by clicking the "Use this template" button. Then, clone the repository locally using the provided link. +Create a new project from the [Profectus repository](https://code.incremental.social/profectus/Profectus) by clicking the "Use this template" button. Then, clone the repository locally using the provided link. ::: info The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider [updating Profectus](./updating.md) _before_ starting development to avoid issues with unrelated histories. ::: -It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The GitHub workflow will automatically rebuild the page when you push to the `main` branch. +It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The workflows will automatically rebuild the page when you push it to the `main` branch. Next, install Profectus' dependencies by running `npm install`. Run `npm run dev` to start a local server hosting your project. The site will automatically reload as you modify files. @@ -23,19 +23,9 @@ Also, follow the steps to [update Profectus](./updating.md) before starting to m ### Deploying -Using Git, the repository's workflow action automates deployment. However, you need to grant write permissions for the action in the repository settings. Go to Actions, General, Workflow permissions, and select "Read and write permissions". +Actions should be enabled by default on new repositories. To deploy, push changes to the main branch. The site will be updated automatically in a few minutes. Check progress or errors from the Actions tab on your repository. -![workflow permissions](./workflow-perms.png) - -To deploy, push changes to the main branch. The site will be updated automatically in a few minutes. Check progress or errors from the Actions tab on your repository. - -![actions button](./actionsbutton.png) - -Enable GitHub Pages in the repo settings to host the generated site. Select the `gh-pages` branch. Perform this step once. This will automatically start another GitHub action to deploy the website. - -![github pages](./gh-pages.png) - -Upon action completion, your project should be available at `https://.github.io//`. For example, the TMT Demo project hosted at https://github.com/profectus-engine/TMT-Demo is available at https://profectus-engine.github.io/TMT-Demo/. +Upon action completion, you will now have a `pages` branch which is automatically available at `https://.pages.incremental.social//`. For example, the TMT Demo project hosted at https://code.incremental.social/profectus/TMT-Demo is available at https://profectus.pages.incremental.social//TMT-Demo/. ### Visual Studio Code Setup diff --git a/docs/guide/getting-started/updating.md b/docs/guide/getting-started/updating.md index 0ec2cb67..bbd013a7 100644 --- a/docs/guide/getting-started/updating.md +++ b/docs/guide/getting-started/updating.md @@ -1,11 +1,11 @@ # Updating Profectus -## Github +## Incremental Social Code Forge Due to Profectus being a template repository, your projects do not share a git history with Profectus. To update changes, you will need to run the following: ```bash -git remote add template https://github.com/profectus-engine/Profectus +git remote add template https://code.incremental.social/profectus/Profectus git fetch --all git merge template/main --allow-unrelated-histories ``` @@ -18,4 +18,4 @@ The sidebar has a tab labeled "Version Control", which you can use to merge all ## Glitch -Unfortunately, Glitch does not provide any method by which to update a project from a Github repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project. +Unfortunately, Glitch does not provide any method by which to update a project from a git repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project. diff --git a/docs/index.md b/docs/index.md index fcb32edd..277f2f93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ features: - title: Easy to Use details: Everything is written to be as intuitive to use as possible, through consistent design. - title: Helpful - details: Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more. + details: Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured workflows and more. - title: Incremental details: Designed to actively encourage you to become better at programming. The engine will never limit you. --- diff --git a/package.json b/package.json index ab2ddfee..c764a70c 100644 --- a/package.json +++ b/package.json @@ -9,13 +9,13 @@ "build": "vitepress build docs", "generate": "tsc --project ./profectus-theme && vue-docgen -c docgen.config.js && cd profectus && vue-typedoc --logLevel Verbose --plugin ../typedoc-theme/index.js --theme profectus --plugin typedoc-plugin-markdown --plugin typedoc-plugin-mdn-links --skipErrorChecking && cd .. && rm docs/api/modules/main.md && node postProcess.js" }, - "repository": "git+https://github.com/profectus-engine/profectus-docs.git", + "repository": "git+https://code.incremental.social/profectus/profectus-docs.git", "author": "thepaperpilot", "license": "ISC", "bugs": { - "url": "https://github.com/profectus-engine/profectus-docs/issues" + "url": "https://code.incremental.social/profectus/profectus-docs/issues" }, - "homepage": "https://github.com/profectus-engine/profectus-docs#readme", + "homepage": "https://code.incremental.social/profectus/profectus-docs#readme", "dependencies": { "vitepress": "^1.0.0-rc.22" },