inspect: portal added to practicalli project templates

practicalli · Oct 17, 2023 · 61b8307 · 61b8307
1 parent 18bca70
commit 61b8307
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - readme: add book overview, update contributing section
 - intro: clarify wording & approach in contributing guide
 - intro: enhance clojure examples and simplify format for experimenting with code
+- dev: checkout action v4 in all GitHub workflow
 
 # 2023-08-14
 
@@ -65,7 +66,7 @@
 - clojure-cli: remove find-deps from repl startup
 - alias: :dev/environment corrections
 - format: updated from local MegaLinter run
-- inspector: update portal configuration 
+- inspector: update portal configuration
 - dev: add test to .PHONY
 - dev: mega-linter-runner no install & remove container
 - ci: update workflows to practicalli common configuration
@@ -99,7 +100,7 @@
 - challenges: update exercism section and and REPL workflow
 - ci: spell lychee & repository trufflehog linters warn only (false positives)
 - install: unattended aternative local location for Clojure CLI
-- clojure-cli: rewrite Clojure REPL section 
+- clojure-cli: rewrite Clojure REPL section
 - automation: rewrite automation overview
 - intro: rewrite introduction on front page
 - intro: more examples in 15 mins page

diff --git a/docs/data-inspector/portal.md b/docs/data-inspector/portal.md
@@ -6,9 +6,18 @@ Portal inspector is a tool for exploration of Clojure data using a browser windo
 
 Registered Portal as a tap source and wrap code with `(tap> ,,,)` to see the results in Portal, providing a more advanced approach to debuging than println.
 
-Using [portal-wrap middleware all evaluation results over nREPL will be sent to Portal](#editor-nrepl-middleware), keeping a history of development.  Add a [custom Mulog publisher](#tap-logs-to-portal) to send all logs to Portal to help with debugging.
+Send all evaluation results to Portal for a complete history using the [portal-wrap nREPL middleware](#editor-nrepl-middleware)
 
-Open Portal from the REPL or [configure Portal to automatically open on REPL startup](#open-portal-on-repl-startup).
+Add a [custom Mulog publisher](#tap-logs-to-portal) to send all logs to Portal to help with debugging.
+
+Open Portal from the REPL or [configure Portal to open on REPL startup](#open-portal-on-repl-startup).
+
+!!! HINT "Practicalli Project Templates"
+    Clojure projects created with [Practicalli Project Templates]() include Portal configuration to recieve all evaluation results and Mulog event logs.
+
+    A custom `dev/user.clj` file loads `dev/portal.clj` and `dev/mulog-events.clj` configurations on REPL startup, when the `dev` directory is included on the path.
+
+    Use the `:repl/reloaded` for a complete REPL reloaded workflow and tooling on REPL startup
 
 
 ![Portal - explore your Clojure data](https://user-images.githubusercontent.com/1986211/196015562-238cf450-6467-451c-a985-04c7a9b49dba.png){loading=lazy}