General improvements to workflow

CHANGELOG.md

@@ -11,7 +11,12 @@
 - *Workspace* - Now the module gets compiled to `/module` with minified files.
 - *Worksapce* - Added `nodejs` to the project.
 - *Workspace* - Added `gulp` to the project.
+- *Type* - Added `ItemInformation` class to descibre values extracted from an item.
+- *Type* - Added `HookInformation` class to describe values extracted from a hook.
+- *Type* - Added `SystemInformation` class to describe values extracted from a system.
+- *Type* - Added `HyperInformation` class to describe meta values of a system.
 - *API* - Exposed only the current `Bridge` as the `API`, which is set based on the current system being used.
 - *Bridge* - Added [DnD5e](https://foundryvtt.com/packages/dnd5e).
+- *Docs* -  Documentation is now generated by `typedoc`, expect to find everything you need there.
 
 ##

README.md

@@ -12,7 +12,16 @@
 
 A FoundryVTT library that provides a **system-agnostic ~~[API]()~~ (WIP)**  to interact with Foundry without worrying about system implementation details.
 
-> Note that this **system-agnostic** approach requires the system to be supported by Bifrost, and that requires a custom ~~[`Bridge`]()~~ (WIP) implementation.
+> [!NOTE]
+> This **system-agnostic** approach requires the system to be supported by Bifrost, and that requires a custom ~~[`Bridge`]()~~ (WIP) implementation.
+
+> [!TIP]
+> If you are developing a system, please consider [supporting]() Bifrost by supplying your own ~~[`Bridge`]()~~ (WIP) implementation, that way you can make your system compatible with all the modules that use Bifrost as the interface to interact with system-specific info.
+
+> [!CAUTION]
+> Please, do not use Bifrost on games where you do not completely trust your players. The module exposes some API functionalities that are not completely safe, **items can be created and deleted** anywhere when using Bifrost, so be careful while using the module.
+>
+> This will be fixed in a near future, but for now if you are in doubt, don't use Bifrost yet!
 
 Do you like the module? Consider supporting it :)
 
@@ -30,4 +39,4 @@ Take a look at the ~~[Documentation]()~~ WIP
 - **V11**
 - ~~**V12**~~ _as soon as it gets released_
 
-<h2 align="center"> <a href="https://github.com/ZotyDev/FoundryVTT-Bifrost/blob/main/CHANGELOG.md"> Changelog</a> </h2>
+<h2 align="center"> <a href="https://github.com/RPG-Made-Simple/FoundryVTT-Bifrost/blob/main/CHANGELOG.md"> Changelog</a> </h2>

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }