Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Fixes and Reorganization #501

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Documentation Fixes and Reorganization #501

wants to merge 3 commits into from

Commits on Nov 11, 2024

  1. Update server-security.md 

    This commit corrects minor grammatical issues within the 'Secure your
events' documentation article.
    @colistro123
    colistro123 committed Nov 11, 2024
    Configuration menu
    Copy the full SHA
    d97392f View commit details
    Browse the repository at this point in the history

  2. 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
```
    @colistro123
    colistro123 committed Nov 11, 2024
    Configuration menu
    Copy the full SHA
    7f2425e View commit details
    Browse the repository at this point in the history

  3. Rebase and add changes from citizenfx#498 

    Adds documentation improvements from PR citizenfx#498 to this commit, thanks @mardev-xyz and
@AvarianKnight.

Original PR: citizenfx#498
    @colistro123
    colistro123 committed Nov 11, 2024
    Configuration menu
    Copy the full SHA
    cf22d9f View commit details
    Browse the repository at this point in the history