Clean up docs & their links

This commit is contained in:
Filip Tibell 2023-03-24 11:56:42 +01:00
parent 9cf6c0f44f
commit 2c6e84bbc1
No known key found for this signature in database
10 changed files with 17 additions and 19 deletions

View file

@ -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. <br />
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

View file

@ -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!

View file

@ -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

View file

@ -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
}
```
## 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"]
```

View file

@ -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.

View file

@ -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.

View file

@ -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!

View file

@ -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.