Tidy documentation (aquasecurity#4639)

ShohamBit · web-flow · commit 94d5107bcfac · 2025-03-18T15:14:35.000-03:00
* fix mkdocs links

* fix macfaq link, and relative links

* fix more relative links

* replace relative links with file links

* remove none existing documentation section

* add back and fix the ordering-event link
diff --git a/docs/contributing/setup-development-machine-with-vagrant.md b/docs/contributing/setup-development-machine-with-vagrant.md
@@ -4,7 +4,7 @@
 all software requirements, packages, operating system configuration, and users
 to provide the same development environment for everyone.
 
-The [Vagrantfile](/Vagrantfile) describes the type of machine required to build Tracee from the [Getting Started](../index.md) guides.
+The [Vagrantfile](https://github.com/aquasecurity/tracee/blob/main/Vagrantfile) describes the type of machine required to build Tracee from the [Getting Started](../index.md) guides.
 
 This allows developers involved in the project to check out the code, run `vagrant up`, and be on their way.
 
diff --git a/docs/docs/events/builtin/syscalls/renameat.md b/docs/docs/events/builtin/syscalls/renameat.md
@@ -34,8 +34,8 @@ A user wants to move a file from one directory to another, without knowing the f
 The `renameat` syscall is vulnerable to TOCTOU issues. This can cause unexpected behavior if the file path or file descriptor becomes invalid between the check and the use.
 
 ## Related Events
-* [openat](#openat) - open a file relative to an existing file descriptor.
-* [unlinkat](#unlinkat) - delete a file or directory, relative to an existing file descriptor.
+* [openat](openat.md) - open a file relative to an existing file descriptor.
+* [unlinkat](unlinkat.md) - delete a file or directory, relative to an existing file descriptor.
 
 > This document was automatically generated by OpenAI and needs review. It might
 > not be accurate and might contain errors. The authors of Tracee recommend that
diff --git a/docs/docs/install/config/cli.md b/docs/docs/install/config/cli.md
@@ -9,4 +9,4 @@ To use the `--config` flag, you need to provide the path to the configuration fi
 ```console
 tracee --config /path/to/tracee-config.yaml
 ```
-__NOTE:__ you can find an example config file in [here](/examples/config/).
+__NOTE:__ you can find an example config file in [here](https://github.com/aquasecurity/tracee/blob/main/examples/config/global_config.yaml).
diff --git a/docs/docs/outputs/output-options.md b/docs/docs/outputs/output-options.md
@@ -53,8 +53,7 @@ Available options:
 
 5. **sort-events**
 
-    This makes it possible to sort the events as they happened. Especially in systems where Tracee tracks lots of events, it can happen that they are received unordered. More information is provided in the [deep-dive](../deep-dive/ordering-events.md) section of the documentation.
-
+    This makes it possible to sort the events as they happened. Especially in systems where Tracee tracks lots of events, it can happen that they are received unordered. More information is provided in the [ordering-event](../advanced/ordering-events.md) section of the documentation.
     ```
     output:
         options:
diff --git a/docs/docs/policies/rules.md b/docs/docs/policies/rules.md
@@ -6,7 +6,7 @@ Rules are part of the Tracee Policy, `rules` let you define which events to trac
 - events: let you define which events you want to trace.
 - filters: enable you to refine the policy's scope.
 
-Tracee support many kind of events to tracee you can find which events you can trace in [Events section](/docs/docs/events/index.md).
+Tracee support many kind of events to tracee you can find which events you can trace in [Events section](../events/index.md).
 
 - **NOTE:** It is possible to define multiple events within each policy.
 
diff --git a/docs/index.md b/docs/index.md
@@ -6,10 +6,10 @@ hide:
 
 👋 Welcome to Tracee Documentation! To help you get around, please notice the different sections at the top global menu:
 
-- You are currently in the [Getting Started](./) section where you can find general information and help with first steps.
-- In the [Tutorials](./tutorials/overview) section you can find step-by-step guides that help you accomplish specific tasks.
-- In the [Docs](./docs/overview) section you can find the complete reference documentation for all of the different features and settings that Tracee has to offer.
-- In the [Contributing](./contributing/overview) section you can find technical developer documentation and contribution guidelines.
+- You are currently in the [Getting Started](index.md) section where you can find general information and help with first steps.
+- In the [Tutorials](tutorials/overview.md) section you can find step-by-step guides that help you accomplish specific tasks.
+- In the [Docs](docs/overview.md) section you can find the complete reference documentation for all of the different features and settings that Tracee has to offer.
+- In the [Contributing](contributing/overview.md) section you can find technical developer documentation and contribution guidelines.
 
 <!-- links that differ between docs and readme -->
 [installation]:./docs/install/index.md
@@ -20,7 +20,7 @@ hide:
 <!-- everything below is copied from readme -->
 
 Before moving on, please consider giving us a GitHub star ⭐️. Thank you!
-
+ 
 ## About Tracee
 
 Tracee is a runtime security and observability tool that helps you understand how your system and applications behave.  
@@ -32,7 +32,7 @@ To learn more about Tracee, check out the [documentation](https://aquasecurity.g
 ## Quickstart
 
 To quickly try Tracee use one of the following snippets. For a more complete installation guide, check out the [Installation section][installation].  
-Tracee should run on most common Linux distributions and kernels. For compatibility information see the [Prerequisites][prereqs] page. Mac users, please read [this FAQ](macfaq).
+Tracee should run on most common Linux distributions and kernels. For compatibility information see the [Prerequisites][prereqs] page. Mac users, please read [this FAQ][macfaq].
 
 ### Using Docker
 
@@ -65,7 +65,7 @@ For a complete walkthrough please see the [Kubernetes getting started guide][kub
 Join the community, and talk to us about any matter in the [GitHub Discussions](https://github.com/aquasecurity/tracee/discussions) or [Slack](https://slack.aquasec.com).  
 If you run into any trouble using Tracee or you would like to give use user feedback, please [create an issue.](https://github.com/aquasecurity/tracee/issues)
 
-Find more information on [contribution documentation](./contributing/overview/).
+Find more information on [contribution documentation](contributing/overview.md).
 
 ## More about Aqua Security
 
diff --git a/docs/tutorials/tracee-vagrant.md b/docs/tutorials/tracee-vagrant.md
@@ -39,4 +39,4 @@ docker run --name tracee -it --rm \
   aquasec/tracee:latest
 ```
 
-To learn how to install Tracee in a production environment, [check out the Kubernetes guide](./kubernetes-quickstart).
+To learn how to install Tracee in a production environment, [check out the Kubernetes guide](../contributing/kubernetes.md).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,6 +109,8 @@ nav:
                             - vfs_readv: docs/events/builtin/extra/vfs_readv.md
                             - security_path_notify: docs/events/builtin/extra/security_path_notify.md
                             - set_fs_pwd: docs/events/builtin/extra/set_fs_pwd.md
+                            - stack_pivot: docs/events/builtin/extra/stack_pivot.md
+                            - suspicious_syscall_source: docs/events/builtin/extra/suspicious_syscall_source.md
                             - tracee_info: docs/events/builtin/extra/tracee_info.md
                             - chmod_common: docs/events/builtin/extra/chmod_common.md
                       - Syscalls:
