From 7f77d5b5a2b9bdae49e33c7d9d0207fa4d94665c Mon Sep 17 00:00:00 2001 From: hybridherbst Date: Fri, 20 Dec 2024 18:26:27 +0100 Subject: [PATCH] update links and headers --- documentation/.vuepress/config.ts | 7 ++++++- documentation/blender/index.md | 15 +++++++++++---- documentation/custom-integrations/index.md | 10 ++++++++++ documentation/deployment.md | 15 +++++++++------ documentation/faq.md | 2 +- documentation/getting-started/index.md | 2 +- documentation/scripting-examples.md | 2 +- documentation/support.md | 2 +- documentation/unity/index.md | 9 ++++++++- 9 files changed, 48 insertions(+), 16 deletions(-) diff --git a/documentation/.vuepress/config.ts b/documentation/.vuepress/config.ts index 415a0e8ca..686950f50 100644 --- a/documentation/.vuepress/config.ts +++ b/documentation/.vuepress/config.ts @@ -136,7 +136,7 @@ export default defineUserConfig({ themes: { light: 'catppuccin-latte', dark: 'catppuccin-frappe' }, lineNumbers: false, highlightLines: false, - __disabled__transformers: [ + transformers: [ // HACK to add the import statement to the code /* { @@ -315,6 +315,7 @@ export default defineUserConfig({ "/blender/", "/three/", "/embedding", + "/cloud/", // "/custom-integrations/", ] }, @@ -497,6 +498,10 @@ export default defineUserConfig({ text: 'Custom integrations', link: '/custom-integrations/', }, + { + text: 'Needle Cloud', + link: '/cloud/', + }, { text: 'Support and Community', link: '/support', diff --git a/documentation/blender/index.md b/documentation/blender/index.md index 0dbba7946..0406b4d3f 100644 --- a/documentation/blender/index.md +++ b/documentation/blender/index.md @@ -3,7 +3,14 @@ title: Needle Engine for Blender editLink: true ---
- +
+ Needle Logo + + +
# Needle Engine for Blender @@ -50,7 +57,7 @@ You'll be able to sequence animations, easily lightmap your scenes, add interact :::tip Providing Feedback -**Your feedback is invaluable** when it comes to deciding which features and workflows we should prioritize. If you have feedback for us (good or bad), please [let us know in the forum](https://forum.needle.tools)! +**Your feedback is invaluable** when it comes to deciding which features and workflows we should prioritize. If you have feedback for us (good or bad), please [let us know in the forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content)! ::: ## Samples for Blender @@ -260,7 +267,7 @@ Alternatively you can also use the Lightmapping panel in the `Render Properties` ![Lightmapping object](/blender/lightmapping-panel.webp) ::: warning Experimental Feature -The lightmapping plugin is experimental. We recommend creating a backup of your .blend file when using it. Please report problems or errors you encounter in [our forum](https://forum.needle.tools) 🙏 +The lightmapping plugin is experimental. We recommend creating a backup of your .blend file when using it. Please report problems or errors you encounter in [our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) 🙏 ::: ## Texture Compression @@ -279,7 +286,7 @@ Simply click the icon to download the new version. ## Reporting an issue -If you run into any problems we're more than happy to help! Please join [our discord](https://discord.needle.tools) for fast support. +If you run into any problems we're more than happy to help! Please join [our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) for fast support. Please also check the logs in Blender. You can find logs specific to the Needle Engine Addon via `Help/Needle` in Blender. diff --git a/documentation/custom-integrations/index.md b/documentation/custom-integrations/index.md index 5b2d8fa35..9cabe9cce 100644 --- a/documentation/custom-integrations/index.md +++ b/documentation/custom-integrations/index.md @@ -1,3 +1,13 @@ +
+
+ Needle Logo + + ?! +
+ # Integrate with other tools ::: warning This page is under construction. diff --git a/documentation/deployment.md b/documentation/deployment.md index e8e80e7dc..d660eceed 100644 --- a/documentation/deployment.md +++ b/documentation/deployment.md @@ -8,8 +8,11 @@ Deployment is the process of making your application available to the public on ## Available Deployment Targets +- [Needle Cloud](./cloud/) + Great for spatial web apps and sharing assets. - [Glitch](#deploy-to-glitch) - No login required, great for experimentation. + Great for experimentation and hacking on server-side code. + - [Netlify](#deploy-to-netlify) Great for hosting your own website and custom domain names. - [itch.io](#deploy-to-itch.io) @@ -18,15 +21,15 @@ Deployment is the process of making your application available to the public on Free static page hosting. - [Vercel](#deploy-to-vercel) Platform for frontend developers -- [Facebook Instant Games](#deploy-to-facebook-instant-games) - Games platform on Facebook and Facebook Messenger - [FTP Upload](#deploy-to-ftp) - Deploy directly to any server with FTP support. + Deploy directly to any server with FTP support. Both FTP and SFTP are supported. - [Build to folder](#build-to-folder) - Bring your project anywhere! + When building to a folder, you can upload the files to any web server or other hosting service. +- [Facebook Instant Games](#deploy-to-facebook-instant-games) + Games platform on Facebook and Facebook Messenger. ::: tip Feel something is missing? -Please let us know in our [discord](https://discord.needle.tools)! +Please let us know in our [forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content)! ::: ## Development Builds diff --git a/documentation/faq.md b/documentation/faq.md index 046aa4bc3..9f5961e53 100644 --- a/documentation/faq.md +++ b/documentation/faq.md @@ -250,7 +250,7 @@ To fix this you can: - Remove the `GltfObject` in the referenced Prefab or Scene - Rename the GameObject with the component that loads the referenced scenes -If this doesn't fix the problem please ask [in our discord](https://discord.needle.tools). +If this doesn't fix the problem please ask [in our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content). ## My scene is not loading and the console contains a warning with 'circular references' or 'failed to update active state' Please see the [circular reference error](#circular-reference-error) section. diff --git a/documentation/getting-started/index.md b/documentation/getting-started/index.md index f8b68e5f1..7a54a2404 100644 --- a/documentation/getting-started/index.md +++ b/documentation/getting-started/index.md @@ -161,5 +161,5 @@ Now that you've installed Needle Engine, you're ready to dive deeper into projec - [Scripting Reference](../scripting.md) In case you need troubleshooting help, please see the [Questions and Answers – FAQ](../faq.md) section. -We welcome you to join our [Forum](https://forum.needle.tools) and [Discord Community](https://discord.needle.tools). +We welcome you to join our [Forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) and [Discord Community](https://discord.needle.tools). diff --git a/documentation/scripting-examples.md b/documentation/scripting-examples.md index 84f5c45b6..ade43762a 100644 --- a/documentation/scripting-examples.md +++ b/documentation/scripting-examples.md @@ -65,7 +65,7 @@ You can also export an array of clips. @[code ts twoslash](@code/component-unityevent.ts) ::: tip EventList events are also invoked on the component level. This means you can also subscribe to the event declared above using ``myComponent.addEventListener("my-event", evt => {...})`` as well. -This is an experimental feature. Please provide feedback in our [forum](https://forum.needle.tools) +This is an experimental feature. Please provide feedback in our [forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) ::: diff --git a/documentation/support.md b/documentation/support.md index ee1990015..83aa11b84 100644 --- a/documentation/support.md +++ b/documentation/support.md @@ -11,7 +11,7 @@ Ask any question about Needle Engine, web development or our editor integrations ## Discord -Chat with the community and share your projects in [Needle Discord](https://discord.needle.tools) +Chat with the community and share your projects in [Needle Discord](https://discord.needle.tools/?utm_source=needle_docs&utm_content=content) ## Get Inspired diff --git a/documentation/unity/index.md b/documentation/unity/index.md index 32b3d1f7f..640b837a6 100644 --- a/documentation/unity/index.md +++ b/documentation/unity/index.md @@ -3,7 +3,14 @@ title: Needle Engine for Unity editLink: true ---
- +
+ Needle Logo + + +
# Needle Engine for Unity