From a97d32795f53a17bdc95b509e829c31a1d50b5d3 Mon Sep 17 00:00:00 2001 From: Ezekiel Date: Fri, 5 Jul 2024 14:15:44 -0700 Subject: [PATCH] feat: made runtime module page look nicer --- src/app/docs/runtime/BUILD.bazel | 1 + .../runtime-module-block.component.html | 15 +++ src/app/docs/runtime/runtime.component.html | 121 +++++++----------- src/app/docs/runtime/runtime.component.ts | 18 ++- 4 files changed, 78 insertions(+), 77 deletions(-) create mode 100644 src/app/docs/runtime/runtime-module-block.component.html diff --git a/src/app/docs/runtime/BUILD.bazel b/src/app/docs/runtime/BUILD.bazel index 61fad218..dfeb8ffb 100644 --- a/src/app/docs/runtime/BUILD.bazel +++ b/src/app/docs/runtime/BUILD.bazel @@ -14,6 +14,7 @@ ng_project( "runtime.component.css", "runtime.component.html", "runtime.component.ts", + "runtime-module-block.component.html", "runtime-routing.module.ts", ], deps = [ diff --git a/src/app/docs/runtime/runtime-module-block.component.html b/src/app/docs/runtime/runtime-module-block.component.html new file mode 100644 index 00000000..fd307361 --- /dev/null +++ b/src/app/docs/runtime/runtime-module-block.component.html @@ -0,0 +1,15 @@ +
+
+

{{ moduleName }}

+

+ article ecsact/runtime/{{ moduleName }}.h +

+
+
+ +
+
diff --git a/src/app/docs/runtime/runtime.component.html b/src/app/docs/runtime/runtime.component.html index 6b7b426a..f6530627 100644 --- a/src/app/docs/runtime/runtime.component.html +++ b/src/app/docs/runtime/runtime.component.html @@ -11,85 +11,58 @@

Ecsact Runtime Library

>.

Modules

+
+
+

+ The core module deals with storage and system execution on that storage. + Entities and their components' data are stored inside a + registry. Systems and actions are executed on a registry's + stored entities and their components based on the system or actions + capabilities. +

+
-

Core

-

- The core module deals with storage and system execution on that storage. - Entities and their components' data are stored inside a registry. - Systems and actions are executed on a registry's stored entities and their - components based on the system or actions capabilities. -

-

- Module methods are available in - article ecsact/runtime/core.h -

+
+

+ The async module handles everything involving using an external async + execution. This includes flushing events, enqueuing execution options, + and receiving async specific errors. +

+
-

Async

-

- The async module handles everything involving using an external async - execution. This includes flushing events, enqueuing execution options, and - receiving async specific errors. -

-

- Async methods are available in - article ecsact/runtime/async.h -

+
+

+ The dynamic module is responsible for creating new types and + even packages at runtime. A type includes enums, components, systems and + actions. Everything you can create when writing an Ecsact file you can + do programmatically with the dynamic module. +

+
-

Dynamic

-

- The dynamic module is responsible for creating new types and even - packages at runtime. A type includes enums, components, systems and actions. - Everything you can create when writing an Ecsact file you can do - programmatically with the dynamic module. -

-

- Module methods are available in - article ecsact/runtime/dynamic.h -

+
+

+ The meta module reveals extra information about the runtime. This + includes debug information, type names, composite fields, system + capabilities and much more. This module isn't needed for simulation and + is mostly used for debugging and tooling. +

+
-

Meta

-

- The meta module reveals extra information about the runtime. This includes - debug information, type names, composite fields, system capabilities and - much more. This module isn't needed for simulation and is mostly used for - debugging and tooling. -

-

- Module methods are available in - article ecsact/runtime/meta.h -

- -

Serialize

-

- The serialize module gives a simple API for serializing composites. Useful - for saving simulation state or sending information over a network. -

-

- Module methods are available in - article ecsact/runtime/serialize.h -

+
+

+ The serialize module gives a simple API for serializing composites. + Useful for saving simulation state or sending information over a + network. +

+
-

Static

-

- The static module reveals a set of components, systems, and actions that - were available at compile-time when the runtime was built. -

-

- Module methods are available in - article ecsact/runtime/static.h -

+
+

+ The static module reveals a set of components, systems, and actions that + were available at compile-time when the runtime was built. +

+
+

Runtime Configurations

diff --git a/src/app/docs/runtime/runtime.component.ts b/src/app/docs/runtime/runtime.component.ts index 26048f5e..0ae8aa00 100644 --- a/src/app/docs/runtime/runtime.component.ts +++ b/src/app/docs/runtime/runtime.component.ts @@ -1,11 +1,23 @@ -import {ChangeDetectionStrategy, Component} from '@angular/core'; -import {RouterLink} from '@angular/router'; +import {CommonModule, NgTemplateOutlet} from '@angular/common'; +import {ChangeDetectionStrategy, Component, Input} from '@angular/core'; +import {RouterLink, RouterModule} from '@angular/router'; + +@Component({ + selector: '[moduleBlock]', + templateUrl: 'runtime-module-block.component.html', + standalone: true, + imports: [RouterModule, CommonModule], +}) +export class RuntimeModuleBlock { + @Input('moduleBlock') + moduleName: string = ''; +} @Component({ templateUrl: 'runtime.component.html', styleUrls: ['runtime.component.scss'], changeDetection: ChangeDetectionStrategy.OnPush, standalone: true, - imports: [RouterLink], + imports: [RouterLink, NgTemplateOutlet, RuntimeModuleBlock], }) export class RuntimeComponent {}