Documentation Fixes and Reorganization #501
Open
Conversation
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
colistro123
force-pushed
the
tweak/reorganize-docs
branch
from
a8c744c
to
dc4053e
Compare
This commit corrects minor grammatical issues within the 'Secure your events' documentation article.
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 ```
Adds documentation improvements from PR citizenfx#498 to this commit, thanks @mardev-xyz and @AvarianKnight. Original PR: citizenfx#498
colistro123
force-pushed
the
tweak/reorganize-docs
branch
from
cbd51cc
to
cf22d9f
Compare
|
Rebased and added improvements from commit #498 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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