From 2c6e84bbc103e3fd4e44f305e91e02c41431a6bd Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Fri, 24 Mar 2023 11:56:42 +0100 Subject: [PATCH] Clean up docs & their links --- CHANGELOG.md | 2 +- README.md | 2 +- docs/SUMMARY.md | 10 +++++----- docs/pages/home/{EditorSetup.md => Editor-Setup.md} | 10 ++++------ docs/pages/home/Installation.md | 4 ++-- docs/pages/home/Intro.md | 2 +- .../home/{RunningScripts.md => Running-Scripts.md} | 0 .../home/{WritingScripts.md => Writing-Scripts.md} | 2 +- docs/pages/roblox/{ApiStatus.md => Api-Status.md} | 0 docs/pages/roblox/Intro.md | 4 ++-- 10 files changed, 17 insertions(+), 19 deletions(-) rename docs/pages/home/{EditorSetup.md => Editor-Setup.md} (72%) rename docs/pages/home/{RunningScripts.md => Running-Scripts.md} (100%) rename docs/pages/home/{WritingScripts.md => Writing-Scripts.md} (98%) rename docs/pages/roblox/{ApiStatus.md => Api-Status.md} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 610dc48..87b1a7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added a `roblox` built-in If you're familiar with [Remodel](https://github.com/rojo-rbx/remodel), this new built-in contains more or less the same APIs, integrated into Lune.
- There are just too many new APIs to list in this changelog, so head over to the [wiki](https://github.com/filiptibell/lune/wiki) to learn more! + There are just too many new APIs to list in this changelog, so head over to the [docs sit](https://lune.gitbook.io/lune/roblox/intro) to learn more! - Added a `serde` built-in diff --git a/README.md b/README.md index 369009b..e6ec97f 100644 --- a/README.md +++ b/README.md @@ -42,4 +42,4 @@ Lune provides fully asynchronous APIs wherever possible, and is built in Rust ## Where do I start? -Head over to the [wiki](https://github.com/filiptibell/lune/wiki) to get started using Lune! +Head over to the [docs site](https://lune.gitbook.io/lune/home/intro) to get started using Lune! diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 358d1ef..7438fe3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -4,15 +4,15 @@ - [Intro](pages/home/Intro.md) - [Installation](pages/home/Installation.md) -- [Writing Scripts](pages/home/WritingScripts.md) -- [Running Scripts](pages/home/RunningScripts.md) -- [Editor Setup](pages/home/EditorSetup.md) +- [Writing Scripts](pages/home/Writing-Scripts.md) +- [Running Scripts](pages/home/Running-Scripts.md) +- [Editor Setup](pages/home/Editor-Setup.md) ## Roblox -- [Intro](pages/roblox/Introduction.md) +- [Intro](pages/roblox/Intro.md) - [Examples](pages/roblox/Examples.md) -- [API Status](pages/roblox/ApiStatus.md) +- [API Status](pages/roblox/Api-Status.md) ## API Reference diff --git a/docs/pages/home/EditorSetup.md b/docs/pages/home/Editor-Setup.md similarity index 72% rename from docs/pages/home/EditorSetup.md rename to docs/pages/home/Editor-Setup.md index bebc313..f3115ff 100644 --- a/docs/pages/home/EditorSetup.md +++ b/docs/pages/home/Editor-Setup.md @@ -11,11 +11,9 @@ These steps assume you have already installed Lune and that it is available to r 3. Modify your VSCode settings, either by using the settings menu or in `settings.json`: ```json - { - "luau-lsp.require.mode": "relativeToFile", // Set the require mode to work with Lune - "luau-lsp.types.definitionFiles": ["luneTypes.d.luau"], // Add type definitions for Lune globals - "luau-lsp.types.documentationFiles": ["luneDocs.json"] // Add documentation for Lune globals - } + "luau-lsp.require.mode": "relativeToFile", // Set the require mode to work with Lune + "luau-lsp.types.definitionFiles": ["luneTypes.d.luau"], // Add type definitions for Lune globals + "luau-lsp.types.documentationFiles": ["luneDocs.json"] // Add documentation for Lune globals ``` ## Selene @@ -28,6 +26,6 @@ These steps assume you have already installed Lune and that it is available to r std = "luau+lune" # OR use this if your project also contains Roblox-specific Luau code: std = "roblox+lune" - # If you are also using the Luau type definitions file, it may cause issues, and can be safely ignored: + # If you are also using the Luau type definitions, they should be excluded: exclude = ["luneTypes.d.luau"] ``` diff --git a/docs/pages/home/Installation.md b/docs/pages/home/Installation.md index 1a30fe3..626789c 100644 --- a/docs/pages/home/Installation.md +++ b/docs/pages/home/Installation.md @@ -32,5 +32,5 @@ There are many tools that can install binaries directly from releases, and it is Congratulations! You've installed Lune and are now ready to write your first script. -- If you want to write standalone scripts, head over to the [Writing Scripts](https://github.com/filiptibell/lune/wiki/Getting-Started---2-Writing-Scripts) page. -- If you want to write Lune scripts specifically for Roblox, check out the [Roblox](https://github.com/filiptibell/lune/wiki/Roblox) section. +- If you want to write standalone scripts, head over to the [Writing Scripts](https://lune.gitbook.io/lune/home/writing-scripts) page. +- If you want to write Lune scripts specifically for Roblox, check out the [Roblox](https://lune.gitbook.io/lune/roblox/intro) section. diff --git a/docs/pages/home/Intro.md b/docs/pages/home/Intro.md index 84d80c8..07a7845 100644 --- a/docs/pages/home/Intro.md +++ b/docs/pages/home/Intro.md @@ -4,4 +4,4 @@ Welcome to the Lune docs site! Here you can find tutorials as well as a full API reference for all of Lune's built-in APIs. -To get started, head over to the [Installation](https://github.com/filiptibell/lune/wiki/Getting-Started---1-Installation) page. +To get started, head over to the [Installation](https://lune.gitbook.io/lune/home/installation) page. diff --git a/docs/pages/home/RunningScripts.md b/docs/pages/home/Running-Scripts.md similarity index 100% rename from docs/pages/home/RunningScripts.md rename to docs/pages/home/Running-Scripts.md diff --git a/docs/pages/home/WritingScripts.md b/docs/pages/home/Writing-Scripts.md similarity index 98% rename from docs/pages/home/WritingScripts.md rename to docs/pages/home/Writing-Scripts.md index 8f72353..2d14429 100644 --- a/docs/pages/home/WritingScripts.md +++ b/docs/pages/home/Writing-Scripts.md @@ -5,7 +5,7 @@ If you've already written some version of Lua (or Luau) scripts before, this walkthrough will make you feel right at home. -Once you have a script you want to run, head over to the [Running Scripts](https://github.com/filiptibell/lune/wiki/Getting-Started---3-Running-Scripts) page. +Once you have a script you want to run, head over to the [Running Scripts](https://lune.gitbook.io/lune/home/running-scripts) page. ## Hello, Lune! diff --git a/docs/pages/roblox/ApiStatus.md b/docs/pages/roblox/Api-Status.md similarity index 100% rename from docs/pages/roblox/ApiStatus.md rename to docs/pages/roblox/Api-Status.md diff --git a/docs/pages/roblox/Intro.md b/docs/pages/roblox/Intro.md index 67e2b6b..5b657ca 100644 --- a/docs/pages/roblox/Intro.md +++ b/docs/pages/roblox/Intro.md @@ -5,6 +5,6 @@ Lune has a powerful built-in library and set of APIs for manipulating Roblox place files and model files. It contains APIs for reading & writing files, and gives you instances to use, just as if you were scripting inside of the Roblox engine, albeit with a more limited API. -For examples on how to write Roblox-specific Lune scripts, check out the [Examples](https://github.com/filiptibell/lune/wiki/Roblox---Examples) page. +For examples on how to write Roblox-specific Lune scripts, check out the [Examples](https://lune.gitbook.io/lune/roblox/examples) page. -For a full list of the currently implemented Roblox APIs, check out the [API Reference](https://github.com/filiptibell/lune/wiki/Roblox---API-Reference) page. +For a full list of the currently implemented Roblox APIs, check out the [API Status](https://lune.gitbook.io/lune/roblox/api-status) page.