Add file linkage to garry's mod platform

blueshank-gh · blueshank-gh · commit 6ee30ba0c94b · 2026-03-09T10:47:57.000-04:00
diff --git a/docs/platforms/garrysmod/database/groups.md b/docs/platforms/garrysmod/database/groups.md
@@ -2,8 +2,10 @@
 Read/write interface for `bsa_groups` plus scoped group-permission links (`bsa_group_permissions`).\
 Includes local cache synchronization and interlink replication handlers.
 
-See [bsa_groups](../../../database/bsa_groups.md) for implementation & design requirements.\
-See [bsa_group_permissions](../../../database/bsa_group_permissions.md) for group-permission implementation & design requirements.
+!!! info
+	See [core/database/tables/groups.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/tables/groups.lua) for the actual design implementation.\
+	See [bsa_groups](../../../database/bsa_groups.md) for implementation & design requirements.\
+	See [bsa_group_permissions](../../../database/bsa_group_permissions.md) for group-permission implementation & design requirements.
 
 ## Constants
 - `#!ts BSA.Storage.Groups.SYSTEM = 1`
diff --git a/docs/platforms/garrysmod/database/interlink.md b/docs/platforms/garrysmod/database/interlink.md
@@ -2,7 +2,9 @@
 Cross-server coordination layer for BSA database services.\
 Manages provider/service/server identity, command fanout (`bsa_command*` tables), acknowledgement polling, and server heartbeat state.
 
-See [bsa_interlink](../../../database/bsa_interlink.md) for implementation & design requirements.
+!!! info
+	See [core/database/interlink.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/interlink.lua) for actual design implementation.\
+	See [bsa_interlink](../../../database/bsa_interlink.md) for implementation & design requirements.
 
 ## Variables
 - `#!ts interlink.poll_rate = 5`\
diff --git a/docs/platforms/garrysmod/database/permissions.md b/docs/platforms/garrysmod/database/permissions.md
@@ -1,7 +1,9 @@
 # Permissions
 Read/write interface for global permission templates in `bsa_permissions`, with interlink replication and local cache updates.
 
-See [bsa_permissions](../../../database/bsa_permissions.md) for implementation & design requirements.
+!!! info
+	See [core/database/tables/permissions.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/tables/permissions.lua) for the actual design implementation.\
+	See [bsa_permissions](../../../database/bsa_permissions.md) for implementation & design requirements.
 
 ## Functions
 - `#!ts permissions:sync(callback?: function(ok: boolean, err?: string))`\
diff --git a/docs/platforms/garrysmod/database/players.md b/docs/platforms/garrysmod/database/players.md
@@ -1,9 +1,11 @@
 # Players
 Read/write interface for `bsa_players`, `bsa_accounts`, and `bsa_player_groups` membership updates, plus account heartbeat/time synchronization.
 
-See [bsa_players](../../../database/bsa_players.md) for player-based implementation & design requirements.\
-See [bsa_accounts](../../../database/bsa_accounts.md) for account-based implementation & design requirements.\
-See [bsa_player_groups](../../../database/bsa_player_groups.md) for player-secondaries implementation & design requirements.
+!!! info
+	See [core/database/tables/players.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/tables/players.lua) for the actual design implementation.\
+	See [bsa_players](../../../database/bsa_players.md) for player-based implementation & design requirements.\
+	See [bsa_accounts](../../../database/bsa_accounts.md) for account-based implementation & design requirements.\
+	See [bsa_player_groups](../../../database/bsa_player_groups.md) for player-secondaries implementation & design requirements.
 
 ## Functions
 - `#!ts players:exists_by_pid(player_id: number, callback?: function(account_data|false, secondaries?: table, err?: string))`\
diff --git a/docs/platforms/garrysmod/database/punishments.md b/docs/platforms/garrysmod/database/punishments.md
@@ -1,7 +1,9 @@
 # Punishments
 Read/write interface for `bsa_punishments` with scoped replication, active-cache management, and periodic expiration invalidation.
 
-See [bsa_punishments](../../../database/bsa_punishments.md) for implementation & design requirements.
+!!! info
+	See [core/database/tables/punishments.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/tables/punishments.lua) for the actual design implementation.\
+	See [bsa_punishments](../../../database/bsa_punishments.md) for implementation & design requirements.
 
 ## Functions
 - `#!ts punishments:add(target: Player|string, invoker: Player|string, type: string, duration?: number, reason: string, callback?: function(entry|false, err?: string))`\
diff --git a/docs/platforms/garrysmod/database/variables/groups.md b/docs/platforms/garrysmod/database/variables/groups.md
@@ -1,6 +1,9 @@
 # Variables: Groups
 Replicated group state layer (`bsa_groups`) exposed as `BSA.Groups`, with helper APIs for inheritance, targeting, and permission aggregation.
 
+!!! info
+	See [core/database/variables/groups.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/variables/groups.lua) for the actual design implementation.
+
 ## Constants
 - `#!ts BSA.Groups.SYSTEM = 1`
 - `#!ts BSA.Groups.CONSOLE = 2`
diff --git a/docs/platforms/garrysmod/database/variables/permissions.md b/docs/platforms/garrysmod/database/variables/permissions.md
@@ -1,6 +1,9 @@
 # Variables: Permissions
 Replicated permission registry (`bsa_permissions`) exposed as `BSA.Permissions`, including CAMI bridge hooks.
 
+!!! info
+	See [core/database/variables/permissions.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/variables/permissions.lua) for the actual design implementation.
+
 ## Functions
 - `#!ts permissions:get(name_id: string|number): table|false`\
 Gets permission by `name` or `perm_id`.
diff --git a/docs/platforms/garrysmod/database/variables/players.md b/docs/platforms/garrysmod/database/variables/players.md
@@ -1,6 +1,9 @@
 # Variables: Players
 Replicated per-player state and player-facing helper API exposed through `BSA.Players` and patched onto the `Player` metatable.
 
+!!! info
+	See [core/database/variables/players.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/variables/players.lua) for the actual design implementation.
+
 ## Runtime Events
 - `#!ts players.initialized(entity: Player)`
 - `#!ts players.connected(steamid64: string, player?: Player)`
diff --git a/docs/platforms/garrysmod/database/variables/punishments.md b/docs/platforms/garrysmod/database/variables/punishments.md
@@ -2,6 +2,10 @@
 Punishment variable bridge for player runtime state.\
 This layer maps active storage punishments to per-player replicated variables and provides type-specific runtime checks.
 
+!!! info
+	See [core/database/variables/punishments.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/database/variables/punishments.lua) for the actual design implementation.\
+	See [core/database/punishments](https://github.com/Buildstruct/bsa-platform-gmod/tree/develop/lua/bsa/core/database/punishments) for punishment type implementations.
+
 ## Shared Helper
 - `#!ts BSA.Punishments.format(entry, type?: string): string?`\
 Builds configured punishment message using scope-specific aspect text and placeholders (`id`, `aspect`, `created`, `expires`, `duration`, `invoker`, `reason`).
diff --git a/docs/platforms/garrysmod/interface/index.md b/docs/platforms/garrysmod/interface/index.md
@@ -3,6 +3,9 @@ Client-side UI manager for BSA, built on custom VGUI classes (`BSA.Interface.*`)
 
 UI classes are derived from Garry's Mod VGUI controls. Some methods are inherited unchanged, some are overridden, and some are BSA-specific extensions.
 
+!!! info
+	See [core/interfaces/client.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/interfaces/client.lua) for the actual design implementation.
+
 ## Runtime Events
 These are `dispatcher` instances on `BSA.Interface`.
 
diff --git a/docs/platforms/garrysmod/libraries/class.md b/docs/platforms/garrysmod/libraries/class.md
@@ -3,6 +3,9 @@ Class is a form of object tracking, inheritance, and metamethod overrides.\
 Without the headaches of those private, public, protected, whatever...\
 Extremely light weight and designed to just be simple, nothing crazy.
 
+!!! info
+	See [core/libraries/class.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/class.lua) for the actual design implementation.
+
 Classes can be constructed in two ways: `namecall` or `:new()`.\
 Both of which allows you to pass arguments into the constructor.\
 However, `:new()` can be overwritten if you need to.
diff --git a/docs/platforms/garrysmod/libraries/command.md b/docs/platforms/garrysmod/libraries/command.md
@@ -1,5 +1,8 @@
 # Commands
-Runtime command tree system with pluggable interfaces, argument parsing/validation, permission hooks, and recursive group routing.
+Runtime command tree system with pluggable interfaces, argument parsing/validation, permission hooks, and recursive group routing.\
+
+!!! info
+	See [core/libraries/command.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/command.lua) for the actual design implementation.
 
 ## Functions
 
diff --git a/docs/platforms/garrysmod/libraries/configurate.md b/docs/platforms/garrysmod/libraries/configurate.md
@@ -1,6 +1,9 @@
 # Configurate
 Hierarchical, class-driven configuration tree with runtime validation, import/export, exposure-safe snapshots, and change/event dispatching.
 
+!!! info
+	See [core/libraries/configurate.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/configurate.lua) for the actual design implementation.
+
 !!! warning
 	Due to how configurate stores data of non-referenced configs, the size may increase from adding/removing configs.\
 	You can clean them by calling `prune` which is for deleting the non-referenced configs, this will however delete that data forever.
diff --git a/docs/platforms/garrysmod/libraries/datastore.md b/docs/platforms/garrysmod/libraries/datastore.md
@@ -1,6 +1,9 @@
 # Datastore
 Database manager abstraction over multiple SQL engines (currently `sqlite` and `mysqloo`) with unified lifecycle/events, query helpers, and optional localized modules.
 
+!!! info
+	See [core/libraries/datastore.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/datastore.lua) for the actual design implementation.
+
 !!! danger
 	We highly recommend using transactions and prepared statements for input-based queries.\
 	Not doing so will leave you susceptible to SQL injection attacks due to human error.
diff --git a/docs/platforms/garrysmod/libraries/dispatcher.md b/docs/platforms/garrysmod/libraries/dispatcher.md
@@ -2,6 +2,9 @@
 Personalized information highways without the need of a global event system.\
 This solves the problem of needing to have hooks everywhere and complicated callback systems.
 
+!!! info
+	See [core/libraries/dispatcher.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/dispatcher.lua) for the actual design implementation.
+
 Simply create a dispatcher, give it a name, and attach as many callbacks as you need.\
 Names on the dispatchers themselves are for tracking purposes when debugging.
 
diff --git a/docs/platforms/garrysmod/libraries/flux.md b/docs/platforms/garrysmod/libraries/flux.md
@@ -2,6 +2,9 @@
 One network string wrapper for multi-channel messaging with SFB/SFS serialization, optional chunk streaming, and built-in replicated variables.
 
 !!! info
+	See [core/libraries/flux.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/flux.lua) for the actual design implementation.
+
+!!! note
 	Garry's Mod has two distinct modes of networking: Reliable & Unreliable.\
 	We recommend using Unreliable for non-critical data, like log streaming for example.\
 	Doing so relieves pressure on the reliable channel which is used way too often by others.
diff --git a/docs/platforms/garrysmod/libraries/nss.md b/docs/platforms/garrysmod/libraries/nss.md
@@ -1,6 +1,9 @@
 # NSS
 Big-integer helper built on 32-bit words for arbitrary-size numeric storage, conversion, arithmetic, and bitwise operations.
 
+!!! info
+	See [core/libraries/nss.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/nss.lua) for the actual design implementation.
+
 ## Functions
 Static constructors and coercion helpers exposed directly on the `nss` class.
 
diff --git a/docs/platforms/garrysmod/libraries/paint.md b/docs/platforms/garrysmod/libraries/paint.md
@@ -1,6 +1,9 @@
 # Paint
 Utility wrappers around `surface`, `draw`, `render`, and `cam` APIs for common UI drawing patterns.
 
+!!! info
+	See [core/libraries/paint.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/paint.lua) for the actual design implementation.
+
 ## Functions
 
 - `#!ts paint.color(r?: number | Color, g?: number, b?: number, a?: number)`\
diff --git a/docs/platforms/garrysmod/libraries/sfb.md b/docs/platforms/garrysmod/libraries/sfb.md
@@ -2,6 +2,9 @@
 Binary read/write primitives used by Flux encoders/decoders and usable standalone for custom binary protocols.\
 Created by Srlion @ https://github.com/Srlion/sfs
 
+!!! info
+	See [core/libraries/sfb.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/sfb.lua) for the actual design implementation.
+
 Flux integration:
 
 - `flux.encoder` inherits `sfb.Writer` via `__index`.
diff --git a/docs/platforms/garrysmod/libraries/sfs.md b/docs/platforms/garrysmod/libraries/sfs.md
@@ -3,6 +3,9 @@ Tagged value serializer/deserializer for Lua and Garry's Mod runtime types.\
 Designed for compact transport of mixed values (`number`, `string`, `table`, entities, vectors, colors, etc.).\
 Created by Srlion @ https://github.com/Srlion/sfs
 
+!!! info
+	See [core/libraries/sfs.lua](https://github.com/Buildstruct/bsa-platform-gmod/blob/develop/lua/bsa/core/libraries/sfs.lua) for the actual design implementation.
+
 Flux integration:
 
 - `flux.encoder:table(...)` and `flux.encoder:any(...)` call `sfs.encode(...)`.
