neo4j-labs · nielsdejong · Nov 15, 2024 · Nov 15, 2024
diff --git a/docs/modules/ROOT/pages/developer-guide/adding-visualizations.adoc b/docs/modules/ROOT/pages/developer-guide/adding-visualizations.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Adding Visualizations
 
+include::../banner.adoc[]
+
 You can extend NeoDash with your own visualizations without diving deep
 into the core application. Likewise, adding a new customization to an
 existing report requires minimal changes.

diff --git a/docs/modules/ROOT/pages/developer-guide/build-and-run.adoc b/docs/modules/ROOT/pages/developer-guide/build-and-run.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Build & Run
 
+include::../banner.adoc[]
+
 To start developing the application, you will need to set up the
 development environment.
 

diff --git a/docs/modules/ROOT/pages/developer-guide/component-overview.adoc b/docs/modules/ROOT/pages/developer-guide/component-overview.adoc
@@ -1,7 +1,6 @@
-include::../banner.adoc[]
-
 = Component Overview
 
+include::../banner.adoc[]
 
 The image below contains a high-level overview of the component
 hierarchy within the application. The following conceptual building

diff --git a/docs/modules/ROOT/pages/developer-guide/configuration.adoc b/docs/modules/ROOT/pages/developer-guide/configuration.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Configuration
 
+include::../banner.adoc[]
+
 When using a custom NeoDash deployment, there are several settings that
 can be configured. These mostly relate to
 link:../standalone-mode[Standalone Mode] and SSO configurations.

diff --git a/docs/modules/ROOT/pages/developer-guide/contributing.adoc b/docs/modules/ROOT/pages/developer-guide/contributing.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Contributing
 
+include::../banner.adoc[]
+
 Contributions to the project are highly welcomed. Please consider
 creating a /~https://github.com/neo4j-labs/neodash/pulls[Pull Request].
 Ensure you start from the `develop` branch, and set the merge base to

diff --git a/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc b/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
@@ -1,6 +1,7 @@
+= Deploy a Build
+
 include::../banner.adoc[]
 
-= Deploy a Build
 If you have a pre-built NeoDash application, you can easily deploy it on an any webserver.
 A NeoDash build is "just" a collection of HTML, CSS and JavaScript files, so it can run virtually anywhere.
 

diff --git a/docs/modules/ROOT/pages/developer-guide/design.adoc b/docs/modules/ROOT/pages/developer-guide/design.adoc
@@ -1,6 +1,7 @@
+= Design
+
 include::../banner.adoc[]
 
-= Design
 
 This page contains some key guidelines for design of the application.
 This entails code architecture, as well as UX/UI design.

diff --git a/docs/modules/ROOT/pages/developer-guide/index.adoc b/docs/modules/ROOT/pages/developer-guide/index.adoc
@@ -1,6 +1,7 @@
+= Developer Guide
+
 include::../banner.adoc[]
 
-= Developer Guide
 
 This guide contains information for developers looking to deploy NeoDash, or extend it for their own needs. 
 

diff --git a/docs/modules/ROOT/pages/developer-guide/session-storage.adoc b/docs/modules/ROOT/pages/developer-guide/session-storage.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Session Storage
 
+include::../banner.adoc[]
+
 This reducer serves only to store data that we want to reset at each new session.
 To connect to it, just define a key and use the predefined actions to set a new pair (key,value) inside of it. 
 Inside the actions there is also an action to delete all the keys that match a precise prefix, it can be useful, for example, to wipe the sessionStorage state for a certain extension, if it stores the data inside the sessionStorage using a prefix (for example look at the query-translator extension at getSessionStorageHistoryKey).
diff --git a/docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc b/docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Standalone Mode
 
+include::../banner.adoc[]
+
 Next to being a dashboard editor, NeoDash can be deployed in a
 `standalone mode' - allowing you set up a architecture to publish and
 read dashboards.

diff --git a/docs/modules/ROOT/pages/developer-guide/state-management.adoc b/docs/modules/ROOT/pages/developer-guide/state-management.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = State Management
 
+include::../banner.adoc[]
+
 NeoDash is an application with a complex internal state. If you are
 planning to extend the application state in some way, make sure you are
 familiar with https://redux.js.org/[Redux] design patterns.

diff --git a/docs/modules/ROOT/pages/developer-guide/style-configuration.adoc b/docs/modules/ROOT/pages/developer-guide/style-configuration.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Style Configuration
 
+include::../banner.adoc[]
+
 When using a custom NeoDash deployment, there are several theme variables that
 can be configured. These mostly relate to css tokens for
 link:https://cdn.jsdelivr.net/npm/@neo4j-ndl/base@1.4.0/lib/tokens/css/tokens.css[Needle] and some other brand specific options.

diff --git a/docs/modules/ROOT/pages/developer-guide/testing.adoc b/docs/modules/ROOT/pages/developer-guide/testing.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Testing 
 
+include::../banner.adoc[]
+
 NeoDash uses *Cypress* for automated testing. To install Cypress, check
 out the official
 https://docs.cypress.io/guides/getting-started/installing-cypress#What-you-ll-learn[installation

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -1,6 +1,7 @@
+= Introduction
+
 include::/banner.adoc[]
 
-= Introduction
 This portal contains information on getting started with NeoDash - A Low-Code Dashboard Builder for Neo4j.
 
 NeoDash is an open source tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports.

diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc
@@ -1,7 +1,7 @@
-include::/banner.adoc[]
-
 = Quickstart
 
+include::/banner.adoc[]
+
 There are three easy ways to run NeoDash and start dashboarding your Neo4j data:
 
 . The latest version is always available online:

diff --git a/docs/modules/ROOT/pages/user-guide/access-control.adoc b/docs/modules/ROOT/pages/user-guide/access-control.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Access Control
 
+include::../banner.adoc[]
+
 The Access Control feature in NeoDash is a security measure that allows Users with write access or higher privileges to manage who has access to specific dashboards.
 
 

diff --git a/docs/modules/ROOT/pages/user-guide/bloom-integration.adoc b/docs/modules/ROOT/pages/user-guide/bloom-integration.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Bloom Integration
 
+include::../banner.adoc[]
+
 NeoDash can be linked to Neo4j Bloom perspectives by using
 https://neo4j.com/docs/bloom-user-guide/current/bloom-tutorial/deep-links/[Bloom
 Deep Links]. This functionality allows you to combine the power of graph

diff --git a/docs/modules/ROOT/pages/user-guide/dashboards.adoc b/docs/modules/ROOT/pages/user-guide/dashboards.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Dashboards
 
+include::../banner.adoc[]
+
 In NeoDash, a dashboard consists of several pages, each of which can
 consist of multiple reports.
 

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/access-control-management.adoc b/docs/modules/ROOT/pages/user-guide/extensions/access-control-management.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Access Control Management
 
+include::../../banner.adoc[]
+
 This extension lets you manage access control for roles and users, letting you assign users to roles as well as controlling which node labels can be read by a user.
 
 This extension is only visible to users with the role of "Administrator" or "Super User". Enabling this extension will allow the admin user to manage the labels of the roles in the database and then attach them to the users.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/advanced-visualizations.adoc b/docs/modules/ROOT/pages/user-guide/extensions/advanced-visualizations.adoc
@@ -1,7 +1,8 @@
-include::../../banner.adoc[]
 
 = Advanced Visualizations
 
+include::../../banner.adoc[]
+
 Advanced visualizations let you extend your dashboard with complex, powerful visualizations beyond the standard visualizations.
 For specific use-cases, these visualizations may convey information that a simple visualization cannot.
 To use advanced visualizations, enable them in the **Extensions Window**. This makes them selectable inside reports, as well as add examples to the Example window.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/forms.adoc b/docs/modules/ROOT/pages/user-guide/extensions/forms.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Forms
 
+include::../../banner.adoc[]
+
 The 'forms' extension lets you combine different parameter selectors to update / modify your graph data.
 Update queries are predefined by the dashboard builder, and the user is limited to specifying the parameters for the query only.
 

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/index.adoc b/docs/modules/ROOT/pages/user-guide/extensions/index.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Extensions
 
+include::../../banner.adoc[]
+
 Extensions provide a way to expand the basic functionality of NeoDash with extra features.
 To enable an extension, open up the extensions window by clicking the puzzle piece icon in the left-sidebar of the screen.
 This will open up the **Extensions Window**, which lets you toggle active extensions for the current dashboard.

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/natural-language-queries.adoc b/docs/modules/ROOT/pages/user-guide/extensions/natural-language-queries.adoc
@@ -1,6 +1,7 @@
+= Text2Cypher - Natural Language Queries
+
 include::../../banner.adoc[]
 
-= Text2Cypher - Natural Language Queries
 Use natural language to generate Cypher queries in NeoDash. Connect to an LLM through an API, and let NeoDash use your database schema + the report types to generate queries automatically.
 
 == How it works

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/report-actions.adoc b/docs/modules/ROOT/pages/user-guide/extensions/report-actions.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Report Actions 
 
+include::../../banner.adoc[]
+
 link:../#_2_pro_extensions[label:Pro&nbsp;Extension[]]
 
 Report actions let dashboard builders add interactivity into dashboards. Actions can be used to achieve:

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/rule-based-styling.adoc b/docs/modules/ROOT/pages/user-guide/extensions/rule-based-styling.adoc
@@ -1,7 +1,6 @@
-include::../../banner.adoc[]
-
 = Rule-Based Styling 
 
+include::../../banner.adoc[]
 
 The rule-based styling extension allows users to dynamically color elements in a visualization based on output values. This can be applied to tables, graphs, bar charts, line charts, and more. To use the extension, click on the 'rule-based styling' icon inside the settings of a report.
 

diff --git a/docs/modules/ROOT/pages/user-guide/extensions/workflows.adoc b/docs/modules/ROOT/pages/user-guide/extensions/workflows.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Workflows
 
+include::../../banner.adoc[]
+
 Introducing an advanced extension for creating, managing, and running workflows with Cypher queries. Simplify ETL flows, execute complex query chains, and run graph data science workloads effortlessly from Neodash.
 
 == Enable the extension

diff --git a/docs/modules/ROOT/pages/user-guide/faq.adoc b/docs/modules/ROOT/pages/user-guide/faq.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = FAQ
 
+include::../banner.adoc[]
+
 == 1. How can I learn more about NeoDash?
 
 To learn more, check out the following list of resources (blogs, videos

diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = User Guide
 
+include::../banner.adoc[]
+
 The following pages contain everything you need to get started with NeoDash.
 
 

diff --git a/docs/modules/ROOT/pages/user-guide/pages.adoc b/docs/modules/ROOT/pages/user-guide/pages.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Pages
 
+include::../banner.adoc[]
+
 A page is a collection of link:../reports[reports] that can be viewed at
 the same time. Each page can have an unlimited number of reports in it,
 and will switch to a scrollable view when the number of reports do not

diff --git a/docs/modules/ROOT/pages/user-guide/publishing.adoc b/docs/modules/ROOT/pages/user-guide/publishing.adoc
@@ -1,7 +1,7 @@
-include::../banner.adoc[]
-
 = Publishing
 
+include::/banner.adoc[]
+
 When you are done building a dashboard, you may want to *publish* that
 dashboard for others to view. The workflow for a continuous dashboarding
 cycle may look something like this:

diff --git a/docs/modules/ROOT/pages/user-guide/reports/areamap.adoc b/docs/modules/ROOT/pages/user-guide/reports/areamap.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Area Map
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 The Area Map charts can be used to render geographical based information on geoJson polygons. It's possible to click a polygon to visualize its regions and their related data.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/bar-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/bar-chart.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Bar Chart
 
+include::../../banner.adoc[]
+
 A bar chart will draw categories and values in a familiar bar-layout.
 The bar chart will require you to choose the following selections:
 

diff --git a/docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc b/docs/modules/ROOT/pages/user-guide/reports/choropleth.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Choropleth
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 A Choropleth chart will render geographical data in geoJson polygons

diff --git a/docs/modules/ROOT/pages/user-guide/reports/circle-packing.adoc b/docs/modules/ROOT/pages/user-guide/reports/circle-packing.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Circle Packing
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 A circle packing chart will render hierarchical data in a group of

diff --git a/docs/modules/ROOT/pages/user-guide/reports/form.adoc b/docs/modules/ROOT/pages/user-guide/reports/form.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Form
 
+include::../../banner.adoc[]
+
 A form is a special type of report that lets users run predefined, parameterized queries.
 A single form can consist of:
 

diff --git a/docs/modules/ROOT/pages/user-guide/reports/gantt.adoc b/docs/modules/ROOT/pages/user-guide/reports/gantt.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Gantt Chart
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 A Gantt chart can be used to visualize tasks on a timeline, as well as their dependencies.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/gauge-chart.adoc b/docs/modules/ROOT/pages/user-guide/reports/gauge-chart.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Gauge Chart
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 A gauge chart takes a single numeric value, and plots it on an animated gauge:

diff --git a/docs/modules/ROOT/pages/user-guide/reports/graph.adoc b/docs/modules/ROOT/pages/user-guide/reports/graph.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = Graph
 
+include::../../banner.adoc[]
+
 The graph report will render all returned nodes, relationships and paths
 in a force-directed graph layout. This includes collections (lists) of
 these objects.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/graph3d.adoc b/docs/modules/ROOT/pages/user-guide/reports/graph3d.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = 3D Graph
 
+include::../../banner.adoc[]
+
 link:../../extensions/advanced-visualizations[label:Advanced&nbsp;Visualization[]]
 
 The 3D graph report extends the default graph visualization with another dimension.

diff --git a/docs/modules/ROOT/pages/user-guide/reports/iframe.adoc b/docs/modules/ROOT/pages/user-guide/reports/iframe.adoc
@@ -1,7 +1,7 @@
-include::../../banner.adoc[]
-
 = iFrame
 
+include::../../banner.adoc[]
+
 An iFrame report lets you embed a webpage inside your NeoDash dashboard.
 The page can be loaded from any web address starting with `http://` or
 `https://`, with some exceptions*.