citizenfx
Documentation Fixes and Reorganization
Summary of Changes
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.
Thanks for reviewing this, I appreciate your time! 😊
Broken Links
I also implemented a parser to verify and correct markdown URLs across the documentation. The parser flagged multiple broken links in the original documentation, which have been fixed in this PR.
The broken links are reflected down below, and the parser can be found here.
All tests were run on a local instance of Hugo by the way.
Table of Broken Links
| Broken URL | From File | Link |
|---|---|---|
| https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/forceRespawn/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md | ./functions/forceRespawn |
| https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/setAutoSpawnCallback/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md | ./functions/setAutoSpawnCallback |
| https://fivem.net/docs/resources/spawnmanager/functions/setAutoSpawn/functions/spawnPlayer/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/setAutoSpawn.md | ./functions/spawnPlayer |
| https://fivem.net/docs/resources/spawnmanager/functions/spawnPlayer/functions/setAutoSpawn/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/spawnPlayer.md | ./functions/setAutoSpawn |
| https://fivem.net/docs/resources/spawnmanager/functions/spawnPlayer/functions/addSpawnPoint/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/resources/spawnmanager/functions/spawnPlayer.md | ./functions/addSpawnPoint |
| https://fivem.net/docs/content/scripting-manual/introduction/creating-your-first-script/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-manual/introduction/about-native-functions.md | /content/scripting-manual/introduction/creating-your-first-script.md |
| https://fivem.net/docs/scripting-manual/nui-development/cef/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-manual/nui-development/_index.md | cef |
| https://fivem.net/docs/scripting-manual/networking/state-bags/ | D:/Users/Ignacio/Desktop/Projects/Resources (Projects that are not mine)/fivem-docs/content/docs/scripting-reference/_index.md | /docs/scripting-manual/networking/state-bags.md |
Rebased and added improvements from commit #498 I believe this should be fine, but if anything let me know, thanks! 😊
Quick important note
If this gets pushed at some point in time, the Make mods link in the FiveM client's mpMenu will need to be updated to match the documentation's URL, that way it doesn't 404. It would need to be updated to https://docs.fivem.net/docs/developers/scripting-manual/introduction/
Closing this since the following commit resolves this. Great work fixing those! Still, navigation contents don't make much sense (as in how there's content laying around that should be in the "Developer docs" section), but changing such would break original links within cfx-ui anyway, leading to 404 errors.