chore: improvements here and there

valeriansaliou · valeriansaliou · commit e6c3910cc9d0 · 2025-06-22T13:10:29.000+02:00
diff --git a/config/common.json b/config/common.json
@@ -200,13 +200,13 @@
 
         "actions"     : [
           {
-            "route" : ["guides", "operating"],
-            "label" : "Server Setup"
+            "route" : ["guides", "dashboard"],
+            "label" : "Use Dashboard"
           },
 
           {
-            "route" : ["guides", "others", "security"],
-            "label" : "Security"
+            "route" : ["guides", "operating"],
+            "label" : "Operate a Pod"
           }
         ]
       },
diff --git a/src/data/guides/basics/download/index.md b/src/data/guides/basics/download/index.md
@@ -4,26 +4,30 @@ UPDATED: 2025-05-28
 
 ## Using our “Downloads” page
 
-Go to [prose.org/downloads](https://prose.org/downloads) and .
+⭐️ _This is the preferred way to install Prose._
+
+Go to [our downloads page](https://prose.org/downloads) and get the Prose application for your platform (macOS or Windows).
 
 ---
 
 ## Using a package manager
 
-### 1. Homebrew
+### 1. Homebrew (macOS)
 
-**To install:**
+**To install the Prose app:**
 
 ```bash
 brew install --cask prose-im/tap/prose
 ```
 
-**Then to update:**
+**Then to update it:**
 
 ```bash
 brew upgrade --cask prose-im/tap/prose
 ```
 
 ### 2. Other package managers
 
-We don’t plan on maintaining packages for every package manager ourselves, but if you maintain a package and would like it to be listed here, feel free to create an issue on [prose-im/prose-docs](https://github.com/prose-im/prose-docs/issues) or reach out to [our support team](#crisp-chat-open) if you don’t have a GitHub account. We will then edit this page to mention your community-maintained package.
+We don’t plan on maintaining packages for every package manager ourselves, but if you maintain a package and would like it to be listed here, feel free to create an issue on [prose-im/prose-docs](https://github.com/prose-im/prose-docs/issues) or reach out to [our support team](https://prose.org/contact/) if you don’t have a GitHub account.
+
+We will then edit this page to mention your community-maintained package.
diff --git a/src/data/guides/basics/index.md b/src/data/guides/basics/index.md
@@ -2,6 +2,8 @@ TITLE: Basics
 INDEX: 1
 UPDATED: 2025-05-31
 
+👋 **Welcome to the Prose Technical docs!** This quickstart guide will help you setup a Prose server, and get Prose apps to run in a matter of minutes. Please follow the guides below in order to get started:
+
 + Navigation
   | Quickstart: Setup Prose in a matter of minutes. -> ./quickstart/
   | Download Prose: Download the Prose app to start chatting. -> ./download/
diff --git a/src/data/guides/dashboard/index.md b/src/data/guides/dashboard/index.md
@@ -2,9 +2,11 @@ TITLE: Using the Dashboard
 INDEX: 2
 UPDATED: 2025-05-28
 
+This section contains tutorials on how to use your Prose Pod dashboard to manage your Pod.
+
 !!! 🚧 This guide is still a work-in-progress.
 
 + Navigation
-  | Inviting members: -> ./invitations/
-  | Configuring your server: -> ./server-config/
-  | Customizing your workspace: -> ./workspace-customization/
+  | Inviting members: Learn how to invite members to your Prose Pod. -> ./invitations/
+  | Configuring your server: Configure your server and tune it to your needs. -> ./server-config/
+  | Customizing your workspace: Customize your workspace with your brand. -> ./workspace-customization/
diff --git a/src/data/guides/index.md b/src/data/guides/index.md
@@ -10,4 +10,4 @@ UPDATED: 2025-05-22
   | Server Setup: Guides to help you setup your own Prose server. -> ./operating/
   | Other guides: Other guides are classified there. -> ./others/
 
-! If you have any technical question while setting up your Prose server, feel free to [chat with our support team](#crisp-chat-open). Our technical support team will gladly help you fix any issue you encounter.
+! If you have any technical question while setting up your Prose server, feel free to [chat with our support team](https://prose.org/contact/). Our technical support team will gladly help you fix any issue you encounter.
diff --git a/src/data/guides/operating/debug/index.md b/src/data/guides/operating/debug/index.md
@@ -9,7 +9,7 @@ When something isn’t working correctly in your Prose Pod, your first source o
 - [Prose apps (client side)](#debugging-prose-apps-client-side)
 - [Prose apps (server side)](#debugging-prose-apps-server-side)
 
-! If you can’t find the source of a problem after reading this guide, feel free to [contact our technical support team](#crisp-chat-open) which will gladly help you identify the issue.
+! If you can’t find the source of a problem after reading this guide, feel free to [contact our technical support team](https://prose.org/contact/) which will gladly help you identify the issue.
 
 ## Debugging the Dashboard (client side)
 
diff --git a/src/data/guides/operating/deploy/index.md b/src/data/guides/operating/deploy/index.md
@@ -165,7 +165,7 @@ Once done, **edit the file to replace all placeholders** with your company infor
 
 To run a Prose Pod on your premises, you have to run all of its parts independently. Each is released as a Docker image, on Docker Hub (see [hub.docker.com/u/proseim](https://hub.docker.com/u/proseim)) and on GitHub’s Container Registry (see [github.com/orgs/prose-im/packages](https://github.com/orgs/prose-im/packages)).
 
-! If you have any technical question while setting up your Prose Pod, feel free to [chat with our technical support team](#crisp-chat-open) which will gladly help you fix any issue you encounter.
+! If you have any technical question while setting up your Prose Pod, feel free to [chat with our technical support team](https://prose.org/contact/) which will gladly help you fix any issue you encounter.
 
 #### Example: Run with Docker Compose
 
@@ -210,7 +210,7 @@ If you see one that has exited, check its logs using:
 docker compose -f /etc/prose/compose.yaml logs --no-log-prefix -- {service_name}
 ```
 
-! If the error logs aren’t clear enough, don’t hesitate [reaching out to our technical support team](#crisp-chat-open).
+! If the error logs aren’t clear enough, don’t hesitate [reaching out to our technical support team](https://prose.org/contact/).
 
 ### Step 4: Configure the reverse proxy
 
@@ -274,7 +274,7 @@ curl http://localhost:3030/api/pod/version
 
 If you get a JSON payload back containing information about the versions of you Prose Pod’s components, it means everything should be working correctly. If you want to make sure everything is well configured or if the call fails, you will have to check the logs.
 
-! If logs don’t guide you to a solution, feel free to [chat with our technical support team](#crisp-chat-open) which will gladly help you fix any issue you encounter.
+! If logs don’t guide you to a solution, feel free to [chat with our technical support team](https://prose.org/contact/) which will gladly help you fix any issue you encounter.
 
 #### Checking logs using Docker Compose
 
@@ -290,13 +290,13 @@ If you don’t see the problem or are missing context, you should check *all* th
 docker compose -f /etc/prose/compose.yaml logs
 ```
 
-If the logs you see still don’t guide you to a solution, [reach out to our technical support team](#crisp-chat-open) which will gladly help you fix any issue you encounter.
+If the logs you see still don’t guide you to a solution, [reach out to our technical support team](https://prose.org/contact/) which will gladly help you fix any issue you encounter.
 
 ### Step 7: Initializing your Prose Pod
 
 Now that your Prose Pod is running, you need to create the first admin account, configure your DNS records and invite your first colleague. All of this can be done using the administration Dashboard which is accessible at `http://localhost:3030`.
 
-!! Those steps could also be done using the Prose Pod API directly but it’s pretty advanced and subject to changes so we won’t document it here. However, if you are interested in doing so you can [reach out to our technical support team](#crisp-chat-open) which will guide you into using the Pod API.
+!! Those steps could also be done using the Prose Pod API directly but it’s pretty advanced and subject to changes so we won’t document it here. However, if you are interested in doing so you can [reach out to our technical support team](https://prose.org/contact/) which will guide you into using the Pod API.
 
 However, you very likely don’t have access to a web browser on the machine where you are running the Prose Pod so you will have to create a first DNS record in order for you to access the Dashboard from your own web browser.
 
@@ -319,7 +319,7 @@ prose 10800 IN CNAME {hostname}
 
 Now, or after a few minutes (for your DNS provider to propagate the new records), you should be able to open `https://prose.{your_domain}:3030` in your web browser and see your Prose Pod Dashboard. If you get a SSL error, go back to [the “SSL certificates” section](#ssl-certificates) and make sure everything is correct.
 
-! If you can’t access your Dashboard at this point, feel free to [contact our technical support team](#crisp-chat-open) which will gladly help you fix your configuration.
+! If you can’t access your Dashboard at this point, feel free to [contact our technical support team](https://prose.org/contact/) which will gladly help you fix your configuration.
 
 Now that you have access to your Dashboard, you can follow [the “Initializing your workspace” section of the “Quickstart” guide](/guides/basics/quickstart/#initializing-your-workspace) to finish configuring your Prose Pod.
 
diff --git a/src/data/guides/operating/telemetry/index.md b/src/data/guides/operating/telemetry/index.md
@@ -21,4 +21,4 @@ For more information, see [“Configuration based on the environment variables
 You can also have a look at [prose-pod-api/local-run/otel-collector-config.yaml](https://github.com/prose-im/prose-pod-api/blob/4654bda8404a043f4d95a67d3cbd84667cd4f009/local-run/otel-collector-config.yaml)
 and [prose-pod-api/local-run/scenarios/default/local-run.env](https://github.com/prose-im/prose-pod-api/blob/4654bda8404a043f4d95a67d3cbd84667cd4f009/local-run/scenarios/default/local-run.env) for an example configuration we use when developing the Prose Pod API. The OpenTelemetry collector is defined in [prose-pod-api/local-run/compose.yaml](https://github.com/prose-im/prose-pod-api/blob/4654bda8404a043f4d95a67d3cbd84667cd4f009/local-run/compose.yaml#L81-L89) and receivers are started using [prose-pod-api/local-run/scripts/otlp](https://github.com/prose-im/prose-pod-api/blob/4654bda8404a043f4d95a67d3cbd84667cd4f009/local-run/scripts/otlp#L272). It’s not production ready but it’s a good base to understand how things relate to one another.
 
-! If you need help setting up telemetry for your self-hosted Prose Pod, feel free to [contact our technical support team](#crisp-chat-open) which will gladly help you set it up.
+! If you need help setting up telemetry for your self-hosted Prose Pod, feel free to [contact our technical support team](https://prose.org/contact/) which will gladly help you set it up.
diff --git a/src/data/guides/others/comparisons/index.md b/src/data/guides/others/comparisons/index.md
diff --git a/src/data/guides/others/index.md b/src/data/guides/others/index.md
diff --git a/src/data/guides/others/security/index.md b/src/data/guides/others/security/index.md
diff --git a/src/data/references/pod-api.md b/src/data/references/pod-api.md
@@ -5,4 +5,12 @@ UPDATED: 2025-05-15
 The Prose Pod API is one way to interact with a Prose Pod. It is what Dashboards use to configure a Prose Pod, and can be used as a way to automate things.
 
 It is subject to changes like new features and improvements, and since Prose Pods can be self-hosted a public documentation might not align with the version you deployed.
-To get the correct OpenAPI description for your Prose Pod, head over to `{prose_pod_dashboard_url}/api/api-docs/openapi.json`, or see it graphically at `{prose_pod_dashboard_url}/api/api-docs/redoc` (replacing `{prose_pod_dashboard_url}` by the URL of your Prose Pod Dashboard).
+
+# API Documentation
+
+**To get the correct OpenAPI description for your Prose Pod, either:**
+
+- Head over to: `{prose_pod_dashboard_url}/api/api-docs/openapi.json`
+- Or, see it graphically at: `{prose_pod_dashboard_url}/api/api-docs/redoc`.
+
+! Replace `{prose_pod_dashboard_url}` by the URL of your Prose Pod Dashboard.
diff --git a/src/data/references/pod-config.md b/src/data/references/pod-config.md

Original file line number	Diff line number	Diff line change
`@@ -200,13 +200,13 @@`
`200`	`200`
`201`	`201`	`"actions" : [`
`202`	`202`	`{`
`203`		`- "route" : ["guides", "operating"],`
`204`		`- "label" : "Server Setup"`
	`203`	`+ "route" : ["guides", "dashboard"],`
	`204`	`+ "label" : "Use Dashboard"`
`205`	`205`	`},`
`206`	`206`
`207`	`207`	`{`
`208`		`- "route" : ["guides", "others", "security"],`
`209`		`- "label" : "Security"`
	`208`	`+ "route" : ["guides", "operating"],`
	`209`	`+ "label" : "Operate a Pod"`
`210`	`210`	`}`
`211`	`211`	`]`
`212`	`212`	`},`