Skip to content

Commit 516c351

Browse files
devin-ai-integration[bot]fern-supportbot_apkfern-api[bot]devalog
authored
Document on-page feedback logging for self-hosted deployments (#4504)
Co-authored-by: fern-support <support@buildwithfern.com> Co-authored-by: bot_apk <apk@cognition.ai> Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent dda0511 commit 516c351

4 files changed

Lines changed: 47 additions & 3 deletions

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
tags: ["self-hosted"]
3+
---
4+
5+
## On-page feedback logging for self-hosted deployments
6+
7+
Self-hosted deployments now log [on-page feedback](/learn/docs/user-feedback) events as structured JSON with the `[fern-docs-feedback]` prefix. Filter your container logs to capture user feedback, including thumbs up/down votes and written messages.
8+
9+
<Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/self-hosted/set-up#on-page-feedback">Read the docs</Button>

fern/products/docs/pages/customization/user-feedback.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ By default, every Markdown page of your docs contains a feedback component at th
2929

3030
You can also disable this feature for [individual pages](/learn/docs/configuration/page-level-settings#on-page-feedback) or [all pages](/learn/docs/configuration/site-level-settings#layouthide-feedback).
3131

32+
<Info title="Self-hosted user feedback">
33+
In [self-hosted](/learn/docs/self-hosted/overview) deployments, feedback events are logged as structured JSON to the container's stdout. See [On-page feedback](/learn/docs/self-hosted/set-up#on-page-feedback) for details.
34+
</Info>
35+
3236
## Edit this page
3337

3438
Allow users to suggest changes to the current page directly from your docs. There are two modes for this feature:
@@ -51,4 +55,4 @@ You can configure this feature — including whether the button links directly t
5155

5256
<Note>
5357
This feature works in preview links but does not work in local development.
54-
</Note>
58+
</Note>

fern/products/docs/pages/enterprise/self-hosted-set-up.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,37 @@ ENV CORS_PROXY_ALLOWED_DOMAINS="plantstore.dev,partner-api.example.com"
168168
|---|---|---|
169169
| `ENABLE_JAEGER` | Set to `true` to start [Jaeger](https://www.jaegertracing.io/) for distributed tracing. The Jaeger UI is available on port 16686. | `false` |
170170

171+
## On-page feedback
172+
173+
In self-hosted mode, [on-page feedback](/learn/docs/user-feedback) events are emitted as structured JSON logs to the container's stdout, prefixed with `[fern-docs-feedback]`. You can filter for these in your logging infrastructure:
174+
175+
```bash
176+
docker logs <container-id> 2>&1 | grep "\[fern-docs-feedback\]"
177+
```
178+
179+
Each log line contains an event name, a timestamp, and a set of properties:
180+
181+
```json
182+
[fern-docs-feedback] {"event":"feedback_submitted","timestamp":"2026-01-15T12:34:56.789Z","properties":{"satisfied":true,"message":"Great docs!","email":"user@example.com","type":"on-page-feedback"}}
183+
```
184+
185+
### Tracked events
186+
187+
| Event | Description |
188+
|---|---|
189+
| `feedback_voted` | A user clicked the thumbs up or thumbs down button. |
190+
| `feedback_submitted` | A user submitted written feedback via the feedback form. |
191+
| `code_block_feedback_submitted` | A user reported an issue with a code example. |
192+
193+
### Properties
194+
195+
| Property | Description |
196+
|---|---|
197+
| `satisfied` | `true` for thumbs up, `false` for thumbs down. |
198+
| `message` | The user's written feedback message (present in `feedback_submitted` and `code_block_feedback_submitted` events). |
199+
| `email` | The user's email address, if provided. |
200+
| `type` | The feedback source, such as `on-page-feedback`. |
201+
171202
## Additional configuration
172203

173204
The following sections cover optional configurations for specific deployment scenarios.

fern/products/docs/pages/enterprise/self-hosted.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ PDF export and **offline AI chat functionality** for self-hosted deployments are
5454
| [llms.txt](/learn/docs/ai-features/llms-txt) | Yes |
5555
| [Navigation and sidebar](/learn/docs/configuration/navigation) | Yes |
5656
| [OAuth](/learn/docs/authentication/setup/oauth) | No |
57-
| [On-page feedback](/learn/docs/user-feedback) | No |
57+
| [On-page feedback](/learn/docs/self-hosted/set-up#on-page-feedback) | Yes |
5858
| [Page-level access control](/learn/docs/configuration/page-level-settings) | Yes |
5959
| [Password protection](/learn/docs/self-hosted/authentication) | Yes |
6060
| [RBAC](/learn/docs/authentication/features/rbac) | No |
@@ -100,7 +100,7 @@ sequenceDiagram
100100

101101
## Monitoring and health checks
102102

103-
The self-hosted container includes [health check endpoints](./health-check-endpoints) on port 8081 for Kubernetes and Helm deployments.
103+
The self-hosted container includes [health check endpoints](./health-check-endpoints) on port 8081 for Kubernetes and Helm deployments.
104104

105105

106106

0 commit comments

Comments
 (0)