-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reorganize Documentation and Fix Broken Links
This PR addresses several issues in the documentation, including incorrect links and inconsistencies in the navigation bar. Notably, the 'Developer Docs' section contained content like "Securing Events," which seemed out of scope. Additionally, there was a structural issue with the naming and placement of sections. Both 'Guides for Scripting' and 'Scripting Reference' were outside the 'Developer Docs', even though they are developer-oriented. This PR reorganizes these sections under 'Developer Docs' for better logical grouping. I also implemented a parser to verify and correct markdown URLs across the documentation. The parser flagged multiple broken links, which have been fixed in this PR. The broken links are reflected down below, the parser can be found [here](https://github.com/colistro123/doc-tools/tree/master/check-links). ``` Broken URL: https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/forceRespawn/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md, link: ./functions/forceRespawn) Broken URL: https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/setAutoSpawnCallback/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md, link: ./functions/setAutoSpawnCallback) Broken URL: https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/spawnPlayer/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md, link: ./functions/spawnPlayer) Broken URL: https://fivem.net/docs/resources/spawnmanager/functions/spawnPlayer/functions/setAutoSpawn/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/spawnPlayer.md, link: ./functions/setAutoSpawn) Broken URL: https://fivem.net/docs/resources/spawnmanager/functions/spawnPlayer/functions/addSpawnPoint/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/spawnPlayer.md, link: ./functions/addSpawnPoint) Broken URL ('.md' extension present): /content/docs/scripting-manual/introduction/creating-your-first-script.md Path: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-manual/introduction/about-native-functions.md Broken URL: https://fivem.net/docs/content/scripting-manual/introduction/creating-your-first-script/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-manual/introduction/about-native-functions.md, link: /content/scripting-manual/introduction/creating-your-first-script.md) Broken URL: https://fivem.net/docs/scripting-manual/nui-development/cef/ (from file: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-manual/nui-development/_index.md, link: cef) Broken URL ('.md' extension present): /docs/scripting-manual/networking/state-bags.md Path: D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-reference/_index.md ```
- Loading branch information
1 parent
aa57e47
commit a8c744c
Showing
175 changed files
with
381 additions
and
366 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,26 @@ | ||
--- | ||
title: Developer docs | ||
weight: 900 | ||
weight: 500 | ||
--- | ||
|
||
This section of the documentation is specific to the core mechanics of FiveM. | ||
## Welcome to the Developer Documentation | ||
|
||
- [Coding guidelines](/docs/developers/coding-guidelines) | ||
This section provides comprehensive coverage of topics ranging from core FiveM mechanics to advanced event handling. | ||
|
||
- [Compiling FiveM](/docs/developers/compiling-fivem) | ||
### Where to Start | ||
|
||
- [Script runtimes](/docs/developers/script-runtimes) | ||
If you’re new to scripting, we highly recommend starting with **[Guides for Scripting](/docs/developers/scripting-manual)**. This will introduce you to the fundamentals and help you build a solid foundation. | ||
|
||
### Explore Further | ||
|
||
- **[Guides for Scripting](/docs/developers/scripting-manual)** | ||
Step-by-step tutorials and practical examples to help you get started. | ||
|
||
- **[Script Runtimes](/docs/developers/script-runtimes)** | ||
Learn about the different runtimes available for scripting in FiveM. | ||
|
||
- **[Scripting Reference](/docs/developers/scripting-reference)** | ||
A complete reference guide for available functions, events, and more. | ||
|
||
<!-- - [Coding guidelines](/docs/developers/coding-guidelines) --> | ||
<!-- - [Compiling FiveM](../../../../docs/developers/compiling-fivem) --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Guides for scripting | ||
weight: 400 | ||
layout: single | ||
--- | ||
|
||
- [Scripting introduction](/docs/developers/scripting-manual/introduction) | ||
- [Introduction to resources](/docs/developers/scripting-manual/introduction/introduction-to-resources) | ||
- [Creating your first script](/docs/developers/scripting-manual/introduction/creating-your-first-script) | ||
- [About native functions](/docs/developers/scripting-manual/introduction/about-native-functions) | ||
- [Scripting runtimes](/docs/developers/scripting-manual/runtimes) | ||
- [Scripting in Lua](/docs/developers/scripting-manual/runtimes/lua) | ||
- [Scripting in JavaScript](/docs/developers/scripting-manual/runtimes/javascript) | ||
- [Scripting in C#](/docs/developers/scripting-manual/runtimes/csharp) | ||
- [Migrating from deprecated methods](/docs/developers/scripting-manual/migrating-from-deprecated) | ||
- [Chat Messages](/docs/developers/scripting-manual/migrating-from-deprecated/chat-messages) | ||
- [Working with events](/docs/developers/scripting-manual/working-with-events) | ||
- [Listening for events](/docs/developers/scripting-manual/working-with-events/listening-for-events) | ||
- [Triggering events](/docs/developers/scripting-manual/working-with-events/triggering-events) | ||
<!-- - [Using events](/docs/developers/scripting-manual/working-with-events/using-events) --> | ||
<!-- - [Creating new events](/docs/developers/scripting-manual/working-with-event/creating-new-events) --> | ||
<!-- - [Server-client communication](/docs/developers/scripting-manual/working-with-event/server-client-communication) --> | ||
- [User interfaces with NUI](/docs/developers/scripting-manual/nui-development) | ||
- [Fullscreen NUI](/docs/developers/scripting-manual/nui-development/full-screen-nui) | ||
- [Direct-rendered UI (DUI)](/docs/developers/scripting-manual/nui-development/dui) | ||
- [NUI callbacks](/docs/developers/scripting-manual/nui-development/nui-callbacks) | ||
- [Loading screens](/docs/developers/scripting-manual/nui-development/loading-screens) | ||
- [Using Scaleform](/docs/developers/scripting-manual/using-scaleform) | ||
- [Voice](/docs/developers/scripting-manual/voice) | ||
- [Using new game features](/docs/developers/scripting-manual/using-new-game-features) | ||
- [Fuel consumption](/docs/developers/scripting-manual/using-new-game-features/fuel-consumption) | ||
- [Collection-based natives](/docs/developers/scripting-manual/using-new-game-features/collection-based-natives) |
File renamed without changes.
File renamed without changes.
11 changes: 11 additions & 0 deletions
11
content/docs/developers/scripting-manual/introduction/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: Scripting introduction | ||
weight: 410 | ||
layout: single | ||
--- | ||
|
||
- [Introduction to resources](/docs/developers/scripting-manual/introduction/introduction-to-resources) | ||
- [Creating your first script in Lua](/docs/developers/scripting-manual/introduction/creating-your-first-script) | ||
- [Creating your first script in C#](/docs/developers/scripting-manual/introduction/creating-your-first-script-csharp) | ||
- [Creating your first script in JavaScript](/docs/developers/scripting-manual/introduction/creating-your-first-script-javascript) | ||
- [About native functions](/docs/developers/scripting-manual/introduction/about-native-functions) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions
13
content/docs/developers/scripting-manual/nui-development/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: User interfaces with NUI | ||
weight: 440 | ||
--- | ||
|
||
**NUI** (short for 'new UI') is the HTML-based user interface functionality in the CitizenFX framework. Currently using | ||
the [Chromium Embedded Framework](https://github.com/chromiumembedded/cef), it offers an asynchronous, performant way of creating in-game UI using | ||
web technologies (HTML/CSS/JS, including frameworks like React or Angular, and accelerated WebGL). | ||
|
||
- [Fullscreen NUI](/docs/developers/scripting-manual/nui-development/full-screen-nui) | ||
- [Direct-rendered UI (DUI)](/docs/developers/scripting-manual/nui-development/dui) | ||
- [NUI callbacks](/docs/developers/scripting-manual/nui-development/nui-callbacks) | ||
- [Loading screens](/docs/developers/scripting-manual/nui-development/loading-screens) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.