feat: javascript and angular docs refactor with integration-interface…

… docs (#6)
onecx · Dec 10, 2024 · 2328dca · 2328dca
1 parent 5089853
commit 2328dca
Show file tree

Hide file tree

Showing 7 changed files with 479 additions and 9 deletions.
diff --git a/docs/modules/angular/nav.adoc b/docs/modules/angular/nav.adoc
diff --git a/docs/modules/angular/partials/nav.adoc b/docs/modules/angular/partials/nav.adoc
@@ -0,0 +1,10 @@
+
+* xref:angular:general/index.adoc[General]
+** xref:angular:general/guidelines.adoc[Guidelines]
+* Cookbook
+* xref:angular:ngrx/ngrx.adoc[NgRx]
+* Libraries
+** xref:angular:libraries/symlink.adoc[How to create a SymLink]
+** xref:angular:libraries/angular-integration-interface.adoc[@onecx/angular-integration-interface]
+** xref:angular:libraries/workingWithSharedLibraries.adoc[]
+
diff --git a/docs/modules/javascript/nav.adoc b/docs/modules/javascript/nav.adoc
@@ -0,0 +1,9 @@
+* Javascript
+** xref:general/index.adoc[General]
+*** Libraries
+**** xref:libraries/integration-interface.adoc[@onecx/integration-interface]
+** Angular
++
+--
+include::angular:partial$nav.adoc[]
+--
diff --git a/docs/modules/javascript/pages/general/index.adoc b/docs/modules/javascript/pages/general/index.adoc
@@ -0,0 +1,13 @@
+= Javascript
+
+== Resources
+
+* Javascript
+** xref:general/index.adoc[General]
+*** Libraries
+**** xref:libraries/integration-interface.adoc[@onecx/integration-interface]
+** Angular
++
+--
+include::angular:partial$nav.adoc[]
+--
diff --git a/docs/modules/javascript/pages/libraries/integration-interface.adoc b/docs/modules/javascript/pages/libraries/integration-interface.adoc
diff --git a/docs/modules/javascript/partials/app-state-service-note.adoc b/docs/modules/javascript/partials/app-state-service-note.adoc
@@ -0,0 +1 @@
+NOTE: For Angular based applications xref:angular-integration-interface.adoc#app_state_service[`@onecx/angular-integration-interface` offers an Injectable AppStateService service] exposing functions usefull when dealing with application state management.
diff --git a/docs/modules/javascript/partials/topic.adoc b/docs/modules/javascript/partials/topic.adoc
@@ -0,0 +1,8 @@
+A Topic is a similar concept to an Observable. They operate on messages passed between UI Apps using browser memory. Each topic:
+
+* has unique name
+* has version
+* can publish new message
+* can be subscribed to and piped for handling new messages
+* can be destroyed to prevent listening to new messages
+With multiple UI Apps having the same Topic instantiated (with the same name), they can communicate with each other based on the publisher-subscriber model. Whenever any Topic instance publishes new message, subscribers for all instances will read the message eventually allowing them to react on new information.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		NOTE: For Angular based applications xref:angular-integration-interface.adoc#app_state_service[`@onecx/angular-integration-interface` offers an Injectable AppStateService service] exposing functions usefull when dealing with application state management.